woaidongmao

文章均收录自他人博客,但不喜标题前加-[转贴],因其丑陋,见谅!~
随笔 - 1469, 文章 - 0, 评论 - 661, 引用 - 0
数据加载中……

模板参数名命名惯例

模板参数名命名惯例

以下模板参数名命名惯例来自于stlsoft,详细说明于《Extended STL》。

模板参数一般是一个或者两个大写字母,
例如T(type/value-type)、S(sequence/string)、
C(container/character)、VP(value policy type)等等。

这样做有两个原因。

首先,全大写字母的单词可能被宏定义。
相反,宏定义一般不会仅有一个或两个字符。
所以模板参数和宏定义没有命名冲突。

(我们不应该自定义特别短的宏。
如果一个库定义了一两个字符的短宏,
一般来说,它绝不会是一个可靠的库。)

第二,我们将在类中定义成员类型,其名字必须不同于模板参数名。

以下代码中,成员类型和模板参数同名,无法通过编译:

template <typename iterator>
struct thing
{
    typedef iterator iterator; // Compile error
};

必须如下代码更改:

template <typename I>
struct thing
{
    typedef I iterator;
};

在定义模板类时,有一个惯例,
即一开始就以上面短小的模板参数名为基础,
定义各个成员类型。


查看StlPort代码:

template <class _Key, class _Tp, ...>
class map
{
  typedef map<_Key, _Tp, _Compare, _Alloc> _Self;
public:
  typedef _Key                  key_type;
  typedef _Tp                   data_type;
  typedef _Tp                   mapped_type;
  typedef pair<const _Key, _Tp> value_type;
  typedef _Compare              key_compare;

  ...
}

其模板参数命名的原则是一致的:较短,然后立即定义较长的类型名。
用前导下划线防止命名冲突。

(转载请注明来源于金庆的专栏)
posted on 2008-04-21 17:25 金庆 阅读(1380) 评论(10)  编辑 收藏 引用 所属分类: 1. C/C++

评论

# re: 模板参数名命名惯例 2008-04-21 19:34 踏雪赤兔
没必要为你那些过时的宏定义搞成这样吧,这样严重地损害了代码可读性。
P.S.:与其参考stlsoft,还不如参考SGI STL更好吧,这也是侯捷的选择  回复  更多评论
 

# re: 模板参数名命名惯例 2008-04-21 19:56 王晓轩
同意楼上的,SGI 的STL实现可以说是可读性最好的~~
  回复  更多评论
 

# re: 模板参数名命名惯例 2008-04-21 22:12 Wang Feng
说起宏定义,其实在文件前面定义,用完了之后在文件最后取消是个很好的习惯
比如

#define PI 3.1415926535897932384626433
.....

#undef PI  回复  更多评论
 

# re: 模板参数名命名惯例 2008-04-22 08:38 Kevin Lynx
原来模板中会优先使用宏。

说实话,作为开源fans,我有点看不惯“(转载请注明来源于金庆的专栏)”这句话。个人感受。  回复  更多评论
 

# re: 模板参数名命名惯例 2008-04-22 09:38 金庆
@踏雪赤兔
SGI STL与StlPort的代码是很相似的,如上述map的定义几乎一样,只是stlport多了些对平台的判断,移植性好点。应该不算“严重地损害了代码可读性”。  回复  更多评论
 

# re: 模板参数名命名惯例 2008-04-22 09:43 金庆
@Wang Feng
取消宏定义是一种方法,这样该宏只能用于当前文件。  回复  更多评论
 

# re: 模板参数名命名惯例 2008-04-22 09:52 金庆
@Kevin Lynx
我的观点是,开源需要亮出自己的名号.
"转载请注明来源于金庆的专栏"是为了方便读者找到原文出处.  回复  更多评论
 

# re: 模板参数名命名惯例 2008-04-22 13:19 eXile
我觉得作为开源的fans,应该更加注重版权的意识。  回复  更多评论
 

# re: 模板参数名命名惯例 2008-04-23 09:08 Kevin Lynx
@金庆
这样的话我还是很赞同的。  回复  更多评论
 

# re: 模板参数名命名惯例 2008-04-25 17:22 #Ant
SGI STL的可读性还是最好的,Wang Feng说的那种宏定义方法也是boost库里面经常用的。  回复  更多评论

posted on 2008-08-31 21:50 肥仔 阅读(326) 评论(0)  编辑 收藏 引用 所属分类: C++ 模板


只有注册用户登录后才能发表评论。
【推荐】超50万行VC++源码: 大型组态工控、电力仿真CAD与GIS源码库
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理