开发人员代码注释规范.doc

开发人员代码注释规范一、 Java类版权及代码注释注释示例：package java.blah;import java.blah.blahdy.BlahBlah;/* * = * Version Author Date Description * 1.0 huangzhihui 2007-11-05 创建 * = */* * Title: Blah.java * Description: * Copyright: Copyright (c) 2009 * Company: Eshore Technology Co.,Ltd. * author huangzhihui * */public class Blah extends SomeClass /* classVar1 documentation comment */ public static int classVar1; /classVar2 documentation comment that happens to be /more than one line long private static Object classVar2; /* * .constructor Blah documentation comment. */ public Blah() / .implementation goes here. /* * .method doSomething documentation comment. */ public void doSomething() / .implementation goes here. /* * .method doSomethingElse documentation comment. * detail description * * another description * * param someParam description * return return value description * throws SomeException exception SomeException description * * see xx.xx.SomeClass#doSomethingElse(String) */ public SomeClass doSomethingElse(Object someParam) throws SomeExcetpion / .implementation goes here. 打开MyEclipse，JavaCode StyleCode TemplatesCodeNew Java file，点击右边的“Edit”，将下面的段落覆盖原文后保存。$package_declaration/* * = * Version Author Date Description * 1.0 $user $year-$month-$date创建 * = */* * Title: $file_name* Description: * Copyright: Copyright (c) $year* Company: Eshore Technology Co.,Ltd.* author $user* */$type_declaration二、 Perl注释注释示例：# perl sendMail.pl Req_reviewer# 1.1# # send the email to notify user deal the flow# #originalField# one name of users input field# string# # it is one parameter of send perl value, a name of users input field# # # format:编号：描述(日期)# 1：增加提出人的一级部门、二级部门、三级部门（20090119）# 2：增加省公司、IT分部对配置类、数据处理类的权限设置（20090120）# 3：修改了期望完成时间字段Req_expectation (20090121)# #use ChangeSynergy:utf8Conditional;use ChangeSynergy:TriggerParser;use ChangeSynergy:csapi;use ChangeSynergy:apiObjectVector;use Net:SMTP;use Net:SMTP_auth; use MIME:Base64;print begin sending email at . & getCurrentTime . n;my $originalField = shift;my users=&getUserId();my $mailServer = ; #邮箱服务器IP地址my $uname = zhangs; #邮箱帐号my $passwd = 111; #邮箱密码my $mailFrom = &enCodeChr(需求管理系统管理员) . ; #邮件服务器对应的真实email地址my $displayForm = &enCodeChr(需求管理系统管理员) . ; #用于收件人收到的邮件中所显示的发件人email地址my $mailTos = &getUserEmail(users); #多收件人时用逗号,分隔开,如:(,);my $mailCcs = ; #多抄送人时用逗号,分隔开,如:(,);my $mailSubject = 中国电信需求管理系统待办通知;my $content = &getContent();# 获取用户邮件地址#*# Function:# 获取用户邮件地址# Parameter:# 用户帐号# Return：# $ res - 该用户的Email地址#*sub getUserEmail my a=_; my $res=; my $i=0; my($trigger,$csapi,$user)=&getConfiguaration(); while($iGetUserPreference($user, $a$i, user_email); if($tmp) my $tmpstr = $tmp-getResponseData(); if($i(a-1) $res.=$tmpstr.,; else $res.=$tmpstr; $i+; return $res;三、 javascript注释注释示例：/* 图表查看系统性能报表(CPU/内存)*/function onclickTR(name)var form = document.forms(0);window.open(netDeviceAction.do?actionFlag=doPerformanceChart&entityId=+form.entityId.value+&name=+name+&typeFlag=device,_blank,left=120,top=50,height=600,width=1000,toolbar=no, menubar=no, scrollbars=yes, resizable=yes,location=no, status=no);/* 查看接口的详情资料*/function onIfDetail(ifId)var form = document.forms(0);window.location.href = netDeviceAction.do?actionFlag=loadIfInfo&ifId= + ifId + &entityId= + form.entityId.value;/* 查看历史报表(24小时、7天、30天)*/function onHisReport(val)var systemId = ;var agentId = ;var taskInstanceId = ;if(systemId = 0 | agentId =0 | taskInstanceId =0)alert(无任何轮循数据);elseonReport(systemId,agentId,taskInstanceId,val);/* 最近一次轮询详细信息*/function onMoreReport()var systemId = ;var agentId = ;va