二维CAD编程规范（终版）

《二维CAD编程规范（终版）》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、二维CAD编程规范一.程序风格1.对变量的定义，尽量位于两数的开始位置，并注释说明变量的用途。2.严格采用阶梯层次组织程序代码，各层次缩进的空格釆用VC的缺省风格，即每层次缩进为4格，括号位于下一行。要求相匹配的大括号在同一列，对继行则要求再缩进4格。3.定义指针时应初始化，设为NULL；释放指针后也要将其设为NULL,pointer二NULL；注释风格1.函数头的注释对于函数，应该从“功能”、“参数”、“返回值”、“主要思路”、“调用方法”、“开发者”、“修改者”、“修改说明”和“日期”九个方面用如下格式注释，如

2、程序经多次修改，每次的修改者，修改H期和修改说明请一一对应。函数说明要尽量清楚，对于简单的函数也要仔细说明，复杂的函数更要详细解释清楚。不要怕繁琐，这些注释对以后的开发者会有很大的帮助。例如：///////////*********************函数^^***************************/////////////功能：从一个String中删除另一个String//参数：strByDelete,strToDelete//参数说明：（入口）strByDelete:被删除的字符串（原来的字符

3、串）//（出口）strToDelete:要从上个字符串屮删除掉的字符串//返回值：找到并删除返回1,否则返回0（或者是其他的一些说明）。//主要思路：本算法主要采用循坏比较的方法来从strByDelete中找到//与strToDelete相匹配的字符串，对多匹配strByDelete中有//多个strToDelete子串的情况没有处理。请参阅：书名......//调用方法：……//开发者：***；开发日期：如：2009/11/3.9:40-2009/11/5.21:45://修改者：***;修改日期：//修改说明：

4、……///////////***********************纟吉束***********************咅*咅*咅*咅/////////〃①对于某些函数，其部分参数为传入值，而部分参数为传出值，所以对参数要详细说明该参数是入口参数，还是出口参数，对于某些意义不明确的参数述要做详细说明，例如：以角度作为参数时，要说明该角度参数是以弧度（PI），还是以度为单位。对既是入口又是岀口的变量应该在入口和出口处同时标明等等。②函数头注释应该放置在函数的头文件和实现文件中，可以使后来的开发者方便的使用函数。③

5、在注释中应该详细说明函数的主要实现思路、特别要注明口己的一些想法，如果有必要则应该写明对想法产生的来由。对一些模仿的函数应该注释上函数的出处。④在注释中详细注明函数的适当调用方法，对于返回值的处理方法等。在注释中要强调调用时的危险方面，可能出错的地方。⑤对日期的注释要求记录从开始写或修改函数到结束写或修改函数的测试之间的日期。⑥修改者与修改日期要相对应，修改说明要详细说明所做的修改部分，包括为何修改，修改了哪些地方，对于公用函数，尽量不修改，可以另写。①如果算法比较复杂，或算法中的变量定义与位置有关，则要求对变量的

6、定义进行图解。对难以理解的算法能图解尽量图解。1.变量的注释对于变量的注释应紧跟在变量的后血说明变量的作用。原则上对于每个变量应该注释，但对于意义非常明显的变量，如：i,j等循坏变量可以不注释。例如：longILineCount//线的根数。2.文件的注释文件应该在文件开头加入以下注释：///////////////////////////////////////////////////////////////////////工程：文件所在的项目名。//开发者：杆*，开发日期：…….//修改者：***,修改日期：/

7、/描述:说明文件的功能。//主要函数：……//版本:针对自己正在开发的项目（如：宝鸡石油或二重）//修改说明：……//参考文献：////////////////////////////////////////////////////////////////////////文件注释可放置在头文件中。参考文献可以注明参考的代码或书籍。为了头文件被重复包含可以対头文件进行定义如下：#ifndef_FILENAME_H_#define_FILENAME_H_其中FILENAME为头文件的名字。3.其他注释在函数内我们不需要

8、注释每一行语句，但必须在各功能模块的每一主要部分之前添加块注释，注释每一组语句，在循环、流程的各分支等，尽可能多加以注释。其中循环、条件、选择等位置必须注释。对于前后顺序不能颠倒的情况，建议在注释屮增加序号。在其他顺序执行的程序中，每隔3—5行语句，必须加一个注释，注明这一段语句所组成的小模块的作用。对于自己的一些比较独特的思想要求在注释中标明。三.命名规则