那谁的技术博客

感兴趣领域:高性能服务器编程,存储,算法,Linux内核
随笔 - 210, 文章 - 0, 评论 - 1183, 引用 - 0
数据加载中……

CGL编码规范V1.0

之前虽然在写代码的时候自己心中有一个编码的规范，但是毕竟没有述之文字，现在回头看了看发现还是有很多地方不够规范的，花了一个晚上扫了一下原有的代码，制定出这个规范，毕竟是写出来白纸黑字的，以后有依可循，这并不是最后的规范版本，我把它命名为V1.0，会根据需要不断的补充完善，并且会check in到SF的SVN中去，有可能的话再写一份E文版的规范，而每次对规范的补充完善相应的都会进行对代码的重构。

这是一个好的习惯，希望我以后不管是作商业上的开发还是自己下面作着玩儿写的代码都按照这些流程走下来，我相信，好的习惯和风格会带来很多积极的影响。

 

CGL编码命名规范V1.0(2007-04-29)

1.变量命名采用匈牙利命名法，如下：
1）整型变量加前缀n
2）指针变量加前缀p
3)自定义也就是typedef声明的新类型变量加前缀t，而这些类型的定义后面加_t后缀，如iter_t
4）char类型加前缀c，char数组加类型sz
5）变量的命名一般为以上的前缀加上相应的描述名词，同时名词第一个字母大写，如piterator_t pIter

2.宏一律大写，并且加上前缀CGL_

3.函数名称加前缀cgl_，如果是某类型的接口函数加上类型名称，其后命名基本参照对应的STL中函数的命名，
    如cgl_list_clear与STL中list容器的clear函数对应
    但是还需要注意的是，如果是在某个文件中的static函数，也就是外部不能使用的函数，前缀改为cgls_
    而对于某个结构体内定义的函数指针类型不需要加上cgl前缀，只需要对函数功能进行说明就可以了，一般为
    动词+名词的形式命名。
    如iterator中的函数指针    data_t                    (*get_value)(piterator_t pIter);就是得到这个iterator
    值的函数。
    
    有了这个规则，那些在CGL中出现的没有这些前缀的函数都是C库中提供的库函数。
    
4.进行比较操作时把常量放在比较操作符左边，如if(NULL != pIter)

5.自定义的数据类型以及结构体的命名习惯为描述该类型的名词 + "_t"，如iterator_t，如果是指向该类型
  变量的指针类型则在前面加上p前缀，如piterator_t
  
6.头文件中为防止重复包含所声明的宏命名规范为该头文件的去掉".h"后缀之后的文件名再加上"_H"后缀，
    同时这个组合的前后都要加上"__"，如cgl_commondef.h头文件中的宏为__CGL_COMMONDEF_H__
    
7.每个文件都要以“CGL_BEGIN”开始，以“CGL_END”结尾

8.不可忽略编译时的警告信息，如果在操作中需要强制转换的要明确写出来，不应依赖于编译器隐式的转换。

9.文件的命名为cgl_前缀加上该文件的描述，一般的，这个后缀与STL中对应的文件名相同，如STL中的list文件
  其在CGL中的对应头文件就是cgl_list.h，c文件就是cgl_list.c
  
10.所有函数的定义前面一律加上对函数功能，输入，输出参数的注释说明  


  
 




 

posted on 2007-04-28 23:48 那谁 阅读(1051) 评论(1)  编辑 收藏 引用 所属分类: CGL

评论

# re: CGL编码规范V1.0  回复  更多评论   

文档建议考虑用 Doxygen
http://www.stack.nl/~dimitri/doxygen/
2007-04-29 03:57 | 8pm

只有注册用户登录后才能发表评论。
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理