<b>关于编程气势的谈论3</b>[VC/C++编程]

3、注释标准:

1、函数头的注释

关于函数,应当从“功效”,“参数”,“返回值”、“主要思绪”、“调用办法”、“日期”六个方面用以下格局注释:

//程序阐明开始

//================================================================//

// 功效: 从一个String 中删除另一个String.

// 参数: strByDelete,strToDelete

// （进口） strByDelete: 被删除的字符串（本来的字符串）

// （出口） strToDelete: 要从上个字符串中删除的字符串.

// 返回: 找到并删除返回1,不然返回0.（对返回值有错误编码的要// 求列出错误编码）.

// 主要思绪:本算法主要采取循环对比的办法来从strByDelete中找到

// 与strToDelete相匹配的字符串,对多匹配strByDelete

// 中有多个strToDelete子串）的情形没有处理.请参阅:

// 书名......

// 调用办法:......

// 日期:起始日期,如:2000/8/21.9:40--2000/8/23.21:45

//================================================================//

函数名(……)

//程序阐明完毕

①、关于某些函数,其部份参数为传入值,而部份参数为传出值,所以对参数要具体阐明该参数是进口参数,还是出口参数,关于某些意义不明确的参数还要做具体阐明（比方:以角度作为参数时,要阐明该角度参数是以弧度（PI）,还是以度为单位）,对既是进口又是出口的变量应当在进口和出口处同时标明.等等.

②、函数的注释应当安排在函数的头文件中,在实现文件中的该函数的实现部份应当同时安排该注释.

③、在注释中应当具体阐明函数的主要实现思绪、分外要注明自己的一些设法,假若有必要则应当写明对设法产生的来因.对一些模拟的函数应当注释上函数的出处.

④、在注释中具体注明函数的得当调用办法,关于返回值的处理办法等.在注释中要夸大调用时的危险方面,大概出错的地方.

⑤、对日期的注释要求记录从开始写函数到完毕函数的测试之间的日期.

⑥、对函数注释开始到函数命名之间应当有一组用来标识的特别字符串.

假如算法对比复杂,或算法中的变量定义与位置有关,则要求对变量的定义举行图解.对难以理解的算法能图解尽大概图解.

2、变量的注释:

关于变量的注释紧跟在变量的背面阐明变量的作用.原则上关于每个变量应当注释,但关于意义十清楚显的变量,如:i,j等循环变量可以不注释.

比方: long lLineCount //线的根数.

　　以上是“<b>关于编程气势的谈论3</b>[VC/C++编程]”的内容，如果你对以上该文章内容感兴趣，你可以看看七道奇为您推荐以下文章：