程序源代码注释规范.doc

《程序源代码注释规范.doc》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、程序注释规范说明程序注释规范应包括以下三方面：一、文件头部注释在代码文件的头部进行注释，这样做的好处在于，我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少个程序员的开发和修改。样本：/*******************************************************作者：Liuchao**创始时间：2007-11-12**修改人：Liuchao**修改时间：2007-11-

2、12**修改人：Liaochao**修改时间：2007-11-12**描述：**   主要用于产品信息的资料录入，…*****************************************************/ 二、函数、属性、类等注释请使用///三斜线注释，这种注释是基于XML的，不仅能导出XML制作帮助文档，而且在各个函数、属性、类等的使用中，编辑环境会自动带出注释，方便你的开发。以protected，protectedInternal，public声明的定义注释都建议以这样命名方法。例如：///