c语言编写规范之注释

c语言编写规范之注释

ID:16662725

大小:20.00 KB

页数:3页

时间:2018-08-23

c语言编写规范之注释_第1页
c语言编写规范之注释_第2页
c语言编写规范之注释_第3页
资源描述:

《c语言编写规范之注释》由会员上传分享,免费在线阅读,更多相关内容在工程资料-天天文库

1、1、头文件包含Includes2、私有类型定义Privatetypedef3、私有定义Privatedefine4、私有宏定义Privatemacro5、私有变量Privatevariables6、私有函数原型Privatefunctionprototypes7、私有函数Privatefunctions8、私有函数前注释/********************************************************************************FunctionName:FSMC_NOR_Init*Description:Confi

2、gurestheFSMCandGPIOstointerfacewiththeNORmemory.*Thisfunctionmustbecalledbeforeanywrite/readoperation*ontheNOR.*Input:None*Output:None*Return:None*******************************************************************************/9、程序块采用缩进风格编写,缩进空格为4。10、相对独立的程序块之间、变量说明之后必须加空行;11、较长的字符(>80字

3、符)要分成多行书写,长表达式要在低优先级操作符划分新行,操作符放在新行之首,新行要恰当缩进,保持排版整齐;12、循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首;13、若函数或过程中的参数较长,则要进行适当的划分。14、不允许把多个短语句写在一行中,即一行只写一条语句。15、if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。16、对齐只使用空格键,不使用TAB键;17、函数或过程的开始、

4、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求18、程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。19、在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格;loanapprovalandpostcre

5、ditapprovalofficer/atalllevelsinaccordancewithcreditapprovalrules,licensingandeventualexerciseofcreditdecisionpowerofpersonsorinstitutions.Reviewfindingsandreviewcomments,accordingtotheBank'scredit20、一行程序以小于80字符为宜,不要写得过长。21、一般情况下,源程序有效注释量必须在20%以上。注释不宜太多、不宜太少,准确易懂简洁;22、说明性文件(如头文件.h文件、.i

6、nc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。23、源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。如:24、函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。25、边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除26、注释的内容要清楚、明了,含义准确,防止注释二义性。说明:错

7、误的注释不但无益反而有害;27、避免在注释中使用缩写,特别是非常用缩写;28、注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。29、数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方;30、全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。31、注释与所描述内容进行同样的缩排32、将注释与其上面的代码用

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。