[第十三届编程基础讲座]如何编写代码是第二部分中最漂亮的部分

*简介: 响应主机的特定实现，提供消息. c

** /

3）. 函数的开头应加注解，列出: 函数的用途/函数，输入参数，输出参数，返回值，调用关系（函数，表）等.

注意: 例如/ ********************************************** * ************************

功能说明: 功能的简要说明

输入参数: 输入参数和功能

返回类型:

初始时间: 2012年2月22日，勒拜什

修订记录: 2012-3-23支持下载过程中意外断开连接，下次下载无错误

使用功能: 简要描述此功能的简单用途和目的

*********************************************** ********************* /

4）. 注释内容应清晰，明确编程基础代码，含义应准确，以免引起歧义.

5）避免在评论中使用缩写，尤其是缩写

6）. 该注释应与其描述的代码相似. 对代码的注释应置于其上方或右侧（对单个语句的注释），而不能位于其下方. 代码用空行分隔

7）对于所有具有物理意义的变量和常量，如果它们的名称没有完全自我注释，则必须在声明过程中对其进行注释以解释其物理含义. 变量，常量和宏应位于右侧附近或上方

8）. 数据结构声明（包括数组，结构，类，枚举等），如果其名称未完全自我注释，则必须对其进行注释. 有关数据结构的注释应放在其上方，而不是下方；结构中每个字段的注释都应放在该字段的右侧

9），全局变量必须具有更详细的注释编程基础代码，包括对其功能，值范围，访问该函数或过程的描述以及访问期间的注意事项等.

评论: 对于评论，单行评论应与上面的内容用空白行隔开

10）. 避免在一行代码或表达式的中间插入注释

11）. 在程序块结束行的右侧添加注释标记，以指示程序块的结束

注释: 当代码段很长时，尤其是在多重嵌套时，可提高代码的可读性

第二个代码版本命名约定

1）代码版本分为: 稳定版和开发版

版本号是根据Linux内核命名规则命名的，并且以r.x.y十进制格式命名

r: 当前的主要版本号（与硬件匹配并与电路板的每个版本匹配）

x: 偶数表示稳定版本，奇数表示开发版本

y: 开发过程中的错误修复升级版本

为了区分不同版本之间的差异，您需要在r.x.y之后添加-LBS（作者名称缩写）

2），版本号升级和更改说明:

r: 随着硬件电路的升级而变化，例如，升级到第二系列的门禁控制板，该版本号设置为2，依此类推

x: 第一次开发时设置为1，并且无法解决工厂维护并返回到研发室进行重新开发，每次设置为3（奇数递增），依此类推. 形成一个稳定的版本，版本号设置为小于其自身的最大偶数

y: 在开发过程中，从0递增到999，出厂后此版本号不会更改，每次升级工厂维护重新计数时，版本号都会增加1.

注: r是与硬件电路匹配的主要版本号，x是内部开发的主要版本号（奇数），y是在开发阶段用于调试，修改和升级的次要版本号，y是工厂维护阶段的维护版本号<

三，代码功能实现规范

1）在同一软件产品中，应计划接口标识符（变量，结构，函数和常量）的命名，以防止在编译和链接期间发生冲突

注意: 例如，在访问控制开发中，可以使用MJ_作为函数头来命名相关函数

2），使用正确的反义词来命名互斥变量或具有相反作用的函数等，并提供以下累加（其他待累加）

添加/删除开始/结束创建/销毁放置/获取

插入/删除first / lastget / releaseup / down

添加/删除锁/解锁打开/关闭剪切/粘贴

最小/最大old /新开始/停止结束/接收

下一个/上一个来源/ targetshow / hidesource /目的地

增加/减少

3）不要设计通用功能，一个功能只能完成一项功能

4）. 尽量不要编写依赖于其他功能的内部实现的功能

注意: 例如，为了实现某个功能，在模块的功能中会调用其他功能，这会影响功能的独立性

5）避免使用无意义或模棱两可的动词来命名函数（例如过程，句柄）

6）. 最好不要使用系统默认的转换方法或强制转换方法将类型不同于函数返回值的变量作为返回值返回

注意: 如果要返回一个int变量，最好让其函数的返回类型也设为int

7）. 具有高扇入和合理扇出的设计功能（扇出是指直接调用其他功能的功能数量，扇入是指调用多少个高级功能）

注意: 当一个具有简单功能的功能只有一个高级功能可调用时，您应考虑将其合并到高级功能中，而不必单独存在

本文来自电脑杂谈，转载请注明本文网址：
http://www.pc-fly.com/a/jisuanjixue/article-166814-1.html