代码规范学习总结

代码规范学习总结

通过自学文档并以小组形式交流,我对代码注释规范有了一个初步了解,下面我将列举我的学习心得及总结。

自建代码注释

在完成代码时,就应标注好相关信息,以下注释应标注于代码开头处:
/*************************************************
作者:
小组:
说明:
创建日期:
版本号:
**********************************************/

此外,对于代码用途也应作相关注释:
///
///depiction:<对该方法的说明>
///
///<paramname="<参数名称>"><参数说明>
///
///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>
///

修改代码注释

修改代码时,应做如下两个注释,分别注释删除的内容和添加的内容:
///修改人:
///修改日期:
///备份:
/原代码内容/

///添加人:
///添加日期:
代码内容
///结束:

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值