通过自学文档并以小组形式交流,我对代码注释规范有了一个初步了解,下面我将列举我的学习心得及总结。
自建代码注释
在完成代码时,就应标注好相关信息,以下注释应标注于代码开头处:
/*************************************************
作者:
小组:
说明:
创建日期:
版本号:
**********************************************/
此外,对于代码用途也应作相关注释:
///
///depiction:<对该方法的说明>
///
///<paramname="<参数名称>"><参数说明>
///
///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>
///
修改代码注释
修改代码时,应做如下两个注释,分别注释删除的内容和添加的内容:
///修改人:
///修改日期:
///备份:
/原代码内容/
///添加人:
///添加日期:
代码内容
///结束: