码迷,mamicode.com
首页 > 其他好文 > 详细

代码书写之注释规范性

时间:2015-03-07 22:33:44      阅读:244      评论:0      收藏:0      [点我收藏+]

标签:

在类名的前面对整个类进行说明:

技术分享
 1 /* *
 2  *类名:AlipayFunction
 3  *功能:支付宝接口公用函数类
 4  *详细:该类是请求、通知返回两个文件所调用的公用函数核心处理文件,不需要修改
 5  *版本:3.3
 6  *日期:2012-08-14
 7  *说明:
 8  *以下代码只是为了方便商户测试而提供的样例代码,商户可以根据自己网站的需要,按照技术文档编写,并非一定要使用该代码。
 9  *该代码仅供学习和研究支付宝接口使用,只是提供一个参考。
10  */
View Code

在类内的每一个函数前面进行说明:

技术分享
1   /** 
2      * 生成文件摘要
3      * @param strFilePath 文件路径
4      * @param file_digest_type 摘要算法
5      * @return 文件摘要结果
6      */
View Code

另外在关键代码出也要用注释进行说明。

代码书写之注释规范性

标签:

原文地址:http://www.cnblogs.com/dobestself-994395/p/4321018.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!