代码风格(五）标识符命名

 

十一、 标识符命名

 

标识符命名要清晰明了，可以使用完整的单词和易于理解的缩写。

 

1、单词缩写

短的单词可以通过去元音形成缩写，较长的单词可以取单词中有意义的3个字母形成缩写。看别人的代码看多了就可以总结出一些缩写惯例，例如count写成cnt，block写成blk，length写成len，window写成win，message写成msg，number写成nrm，temporary可以写成tem，也可以进一步写成tmp，最有意思的是internationalization写成i18n，词根trans经常缩写成x，例如transmit写成xmt。

 

2、局部变量和函数名

内核编码风格规定变量、函数和类型采用全小写加下划线的方式命名，常量（比如宏定义和枚举常量）采用全大写加下划线的方式命名。

例如：

函数名radix_tree_insert( )   sort_msg( )

类型名struct radix_tree_root

常量名RADIX_TREE_MAP_SHIFT等。

 

3、  全局变量和全局函数的命名

全局变量和全局函数的命名在整个项目的许多源文件中都会用到，必须让使用者明确这个变量或函数是干什么用的，因此一定要详细，不惜多用几个单词多写几个下划线，或者用特殊字符加以标识。

例如：

函数名 char *get_msg_from_socket( );

全局变量名 char *__g_msg_que[MSG_MAX];