代码注释规范说明.doc

《代码注释规范说明.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、CommentscriterionoftheCode在多个PROJIECT共同开发的前提下，为了减少修改升级CODE过程中出现失误和方便SI人员对代码的维护，加强部门整体代码注释规范，建议通过在每一次代码修改过程中添加代码标志符进行注释，这样可以使软件工程师在升级代码的过程中减少错误率，同时可以保持对以前版本代码的修改思路清晰，能在最短时间里复查代码中的错误。标准C++/C的文件结构：//Copyright(c)MicrosoftCorporation.Allrightsreserved.//Useofthissourcecode

2、issubjecttothetermsoftheMicrosoftend-user//licenseagreement(EULA)underwhichyoulicensedthisSOFTWAREPRODUCT.//IfyoudidnotacceptthetermsoftheEULA,youarenotauthorizedtouse//thissourcecode.ForacopyoftheEULA,pleaseseetheLICENSE.RTFonyour//installmedia./***PortCopyright(c)Hi

3、sysCorporation.Allrightsreserved.*@filebatt_pdd.c*Abstract*ThisfilecontainsbatterydriverPDDimplementation.*ChangeLog*2006.2.21ShiYuehuaInitialVersion***/代码注释规范如下：//***********COMMENTS-HISTORY***********///***************************************************************

4、****************NAME

5、SIGN

6、PROJECT

7、SUMMARY**------------------------------------------------------------------------------*Johson.LiM060806_AHXS006Usethetwomethodstomeasurethebatteryvoltage.*Johson.LiM060812_AHXS010Changetheinitarrayvaluefrom4to8.*Johson.LiM060812_BCOM

8、MONChangetheUSBCHANGINGconditions.*...........*...........******************************************************************************/代码注释标题声明包含四部分：1.作者名称2.标记符3.项目名称4.摘要1.《NAME》：修改该部分CODE的软件人员名称（英文名称&中文名称拼音缩写），第一个字母大写。2．《SIGN》：该标记符应在所有本次修改代码前面声明，主要是为了方便搜索，当我们想查找本次为

9、了实现某个功能所做的代码修改时，可以搜索此标记符，即可找到全部修改过的相关代码段。标记符：M060806_AM:英文缩写060806：代表修改日期为2006.08.06A：代表当天添加或者修改的第一项功能。如果当日继续做其他有别与本次功能差异的修改，可以采用M060806_B的方法，依次类推（A、B、C、D、E、F……）.3．《PROJECT》：主要描述当前代码的修改所针对的项目，由于以后的多个项目可能用一套代码通过宏来定义，所以如果当前代码的修改是针对两个或两个以上的项目，我们这里使用COMMON加以区分。4.《

10、SUMMARY》：主要简述此次代码修改的目的或者解决某个BUG的方法。********************************************************************************〈Sample-1〉：//M060806_Astart/*DoBatteryVoltageMeasure*/staticBOOLg_batteryADC=FALSE;staticDWORDdwCyc=0;staticDWORDdwCount=0;//M060806_Aend：//M06

11、0812_Bstart--ChangetheUSBCHANGINGconditions/*if(gpioGetValue(g_pGPIOregs,80)==0)//nCHGassert{if(dwVolt