自主开发齿轮专用软件程序代码的书写规范.pdf

科技信息 计算机与网络 自主开发齿轮薹用软件程序代码帕书写规范 宁夏大学新华学院 李 辉 [摘 要]利用vc++自主开发圆弧齿轮CAD／CAE专用软件过程中，针对程序代码冗长，模块结构混乱等问题，提 出了相应的基本 要求并进行必要的规范，不仅提高了代码可读性、继承性与可扩展性，降低后期维护成本，也有利于齿轮软件后续的开发。 [关键词]程序 基本要求 规范 前言 ①命名必须具有一定的实际意义，形式为xAbcFgh，其中x由变量类 先有规矩后有方圆，编程也如此 ，规范的代码是对一个程序员最基 型确定，Abc、Fgh表示连续意义字符串。 本的要求。尤其是自主开发专用软件，程序量较大，程序结构关系错综 ②变量的名称应当能表达出它的用途，尽量不缩写 ，并使用名词作 复杂，只有对程序代码进行必要的规范，才能使程序代码具有更好的继 为变量名。 承性 、可扩展性，并有利于后人继续进行开发。 ③变量名应该用类型的缩写作为前缀，比如strMasterSql。 1．编写程序的基本要求 ④循环控制变量可以是单个字母如 I、J、K，也可以使用具有含义的 1．1可读性要求 名称。 (1)程序结构清晰，代码力求简洁，避免垃圾程序，避免太多的分支 ⑤布尔变量的名称必须能清楚的表示出True和False的意义。 结构及太过于技巧性的程序。 ⑥防止局部变量与公共变量同名。 (2)尽量使用标准库函数和公共函数，单个函数的程序行数不得超 (2)常量命名和宏定义 过 100行，循环 、分支层次不要超过五层。 常量和宏定义必须具有一定的实际意义；常量和宏定义在 #include (3)每个源程序文件，都应有文件头说明，每个函数，都应有函数头 和函数定义之间： 说明，主要变量 (结构、类或对象)定义或引用时，注释能反映其含义，常 规范要求：常量和宏定义必须全部以大写字母来命名，单词与单词 量定义(DEFlNE)有相应说明。 之间必须采用连字符 “～”连接，每一条定义的右侧必须有一简单的注释， (4)对于每个block、典型算法和比较大的或特殊的函数调用，都必 说明其作用。 须注释其功能，并保持注释与代码完全一致。 如 ：#definePI3．1415926 ／I／IH／／把 程序 中出现 的PI全部换成 (5)~tl用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单 3．1415926。 位。 (3)函数命名 (6)版本封存后的修改一定要将修改前的语句用 ，封闭，不能 自 函数的命名：函数名首字大写，若包含有两个单词的每个单词首字 行删除或修改，并要在文件及函数的修改记录中加以记录。 母大写，函数名应当有意义，并应尽量使用动宾词组。 1．2结构化要求 示例如下： (1)禁止GOTO语句。 在齿轮三维CAD系统中，实现双圆弧齿轮三维实体参数化设计需 (2)禁止出现两条等价的支路。 要四个参数：模数 nl，齿数 teeth，螺旋角helixangle，齿宽gearwidth，函数 (3)用 IF语句来强调只执行两组语句中的一组；