开发人员代码注释规范

《开发人员代码注释规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、开发人员代码注释规范一、Java类版权及代码注释注释示例：packagejava.blah;importjava.blah.blahdy.BlahBlah;/**==========================================================*VersionAuthorDateDescription*1.0huangzhihui2007-11-05创建*==========================================================*//***

2、Title:Blah.java

Description:

Copyright:Copyright(c)2009

Company:EshoreTechnologyCo.,Ltd.

3、ppenstobe//morethanonelinelongprivatestaticObjectclassVar2;/***...constructorBlahdocumentationcomment...*/publicBlah(){//...implementationgoeshere...}/***...methoddoSomethingdocumentationcomment...*/publicvoiddoSomething(){//...implementationgoeshere...}/***...me

4、thoddoSomethingElsedocumentationcomment...*

detaildescription

anotherdescription

5、ClassdoSomethingElse(ObjectsomeParam)throwsSomeExcetpion{//...implementationgoeshere...}}打开MyEclipse，，JavaàCodeStyleàCodeTemplatesàCodeàNewJavafile，点击右边的“Edit”，将下面的段落覆盖原文后保存。${package_declaration}/**==========================================================*Versi

6、onAuthorDateDescription*1.0${user}${year}-${month}-${date}创建*==========================================================*//***

Title:${file_name}

Description:

Copyright:Copyright(c)${year}

Company:EshoreTechnologyCo.,Ltd.

7、*/${type_declaration}一、Perl注释注释示例：##perlsendMail.plReq_reviewer#1.1##sendtheemailtonotifyuserdealtheflow###originalField#onenameofusersinputfield#

8、ype>string##itisoneparameterofsendperlvalue,anameofusersinputfield####format:编号：描述(日期)#1：增加提出人的一级部门、二级部门