程序注释格式

转载 2007年09月17日 17:13:00

程序注释格式

                                      

 

编写正确格式的注释说明
头文件头部注释规范,注释必须列出版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明:
 /////////////////////////////////////////////////////////////////////////////////
/// Copyright (C), 2005-2007.
/// file  WindowsNT
  /// brief Windows Nice Try.
/// author Bill Gates
  /// author Several species of small furry animals gathered together 
  ///          in a cave and grooving with a pict.
  /// version 4.0
  /// date    1996-1998
  /// warning This class may explode in your face.
  /// warning If you inherit anything from this class, you're doomed.
  /// ClassList:主要函数列表,每条记录应包括函数名及功能简要说明
/// 1. ....
 /// History: 修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述
///         <author> <time>    <version >   <desc>
///      Hsz   2005/4/12     1.0     build this moudle 
  ////////////////////////////////////////////////////////////////////////////////////
 
源文件头部注释规范,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内:
 /////////////////////////////////////////////////////////////////////////////////
/// Copyright (C), 2005-2007,
/// /file  WindowsNT
  /// /brief Windows Nice Try.
  /// /author Bill Gates
  /// /author Several species of small furry animals gathered together 
  ///          in a cave and grooving with a pict.
  /// /version 4.0
  /// /date    1996-1998
  /// /warning This class may explode in your face.
  /// /warning If you inherit anything from this class, you're doomed.
  /// /Function List:主要函数列表,每条记录应包括函数名及功能简要说明
/// 1. ....
 /// /History: 修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述
///         <author> <time>    <version >   <desc>
///      Hsz    2005/4/12     1.0     build this moudle 
  /////////////////////////////////////////////////////////////////////////////////
 
 
 
 
函数头部注释规范,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内:
 /////////////////////////////////////////////////////////////////////////////////
///  /fn    函数名称
/// /brief 函数功能、性能等的描述.
/// /param[in] 参数 c a char.
/// /param[out] 参数        n an int.
/// /exception 异常 std::out_of_range parameter is out of range.
/// /return 返回值 a char pointer.
/////////////////////////////////////////////////////////////////////////////////
 
 
类的头部注释规范:
 /////////////////////////////////////////////////////////////////////////////////
/// /class 类名字 类所在文件 "文件路径"
/// /brief 大纲描述.
///
/// 详细描述类的功能
 /////////////////////////////////////////////////////////////////////////////////
 
类成员定义的注释规范:
成员函数
/// A function.
/// A more elaborate description of the constructor.
 
成员变量
///< a public variable. Details
标准类型的注释规范
Enum
第一种方法
//////////////////////////////////////////////////
/// /enum TEnum
/// A description of the enum type.
//////////////////////////////////////////////////
enum TEnum { 
                Val1, /// /var Enum Val1
                Val2 ///      Enum Val2
            };
 
第二种方法
enum在类内部定义
//////////////////////////////////////////////////
/// /enum An enum
/// More detailed enum description..
//////////////////////////////////////////////////
enum TEnum { 
          TVal1, ///< enum value TVal1. 
          TVal2, ///< enum value TVal2. 
          TVal3 ///< enum value TVal3. 
         } 
       *enumPtr,  ///< enum pointer. Details. 
        enumVar; ///< enum variable. Details. 
 
#define macro宏定义
//////////////////////////////////////////////////
/// /def MAX(x,y)
/// Computes the maximum of /a x and /a y.
//////////////////////////////////////////////////
 
typedef类型定义
//////////////////////////////////////////////////
/// /typedef std::string YString
/// typedef YString.
//////////////////////////////////////////////////
 
Struct结构
//////////////////////////////////////////////////
///  /struct Test struct.h "inc/ struct.h"
/// /brief This is a test struct.
/// Some details about the Test struct
///////////////////////////////////////////////////
 
变量定义
 ///////////////////////////////////////////////////
/// /var int g_nCount
/// The description of the int value.
///////////////////////////////////////////////////
 

手把手教你写_“华为”_的标准注释与文档,以及代码规范

为什么要写注释呢?为什么要写文档呢?  也许有人会这样问。但是我只想说如果你还在这样问,那么你不仅不是一个优秀的程序员,应该说你是不是程序员都应该受到质疑。 先说一下注释的重要性:  在公司...
  • zheng_guan
  • zheng_guan
  • 2016年11月20日 23:49
  • 4559

Eclipse 修改注释的 date time 日期时间格式,即${date}变量格式

Eclipse 修改注释的 date time 日期时间格式,即${date}变量格式 找到eclipse安装目录下面的plugins目录,搜索 org.eclipse.text ,找到一个ja...
  • zollty
  • zollty
  • 2015年06月11日 17:09
  • 10326

C++编程规范 头文件格式 和 函数注释格式

C++编码规范(1):代码注释 当你阅读别人的代码时如果没有注释那会是件比较痛苦的事.一说到注释我们马上想到是通过//或/* */这样来添加一些描述信息.这只是狭义的注释. 广义的...
  • guyue35
  • guyue35
  • 2015年07月06日 15:30
  • 3388

Eclipse注释日期修改

本文修改自http://borisbobo.iteye.com/blog/1478181 在Eclipse项目中的日期格式显示如下:    找到eclipse.ini  在里面-Duser.la...
  • shuchangwen
  • shuchangwen
  • 2015年01月20日 15:04
  • 3889

华为软件编程规范和范例 1 ——排版和注释

华为软件编程规范和范例 1. 排版 1.1    程序块要采用缩进风格编写, 缩进的空格数为4个。 说明: 对于由开发工具自动生成的代码可以有不一致。 1.2  ...
  • Cowena
  • Cowena
  • 2015年08月05日 10:35
  • 1311

Doxygen使用学习(一)------Doxygen的简单注释格式

最近,我通过看别人的没有文档代码,终于醒悟了,感觉到了文档的重要性!(看不懂别人代码的痛苦太难受了!) 所以我觉定,趁着周末赶快学习一下如何使用文档生成工具。 通过网上检索,我发现Doxygen是一...
  • qq_19528953
  • qq_19528953
  • 2016年08月12日 12:52
  • 1189

怎么修改eclipse中注释的格式

Eclipse注释模板设置详解 设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是...
  • u011285162
  • u011285162
  • 2013年10月17日 13:51
  • 1519

C语言数据结构队列实现舞伴匹配(数据结构第二次实验)

C语言实验作业 题目如下: 课程名称:数据结构 实验目的: 1.掌握队列的定义及实现; 2.掌握利用队列的基本操作。 实验要求: 1、    使用链式结构完成队列的各种基本操作; 2、    补充完...
  • Wofficre
  • Wofficre
  • 2017年11月12日 13:45
  • 109

eclipse修改注释日期格式

编译修改的文件:前提要配置java环境变量 运行命令如下,由于会依赖com.ibm.icu包内容 javac  -classpath  E:\eclipse\plugins\com.ibm.icu_3...
  • kefeng824
  • kefeng824
  • 2016年01月11日 11:22
  • 1171

如何写PHP规范注释

转载自:http://hi.baidu.com/leo5210/item/291877ea5f125c345b7cfb83 所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间...
  • qq43599939
  • qq43599939
  • 2013年10月11日 13:38
  • 2493
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:程序注释格式
举报原因:
原因补充:

(最多只允许输入30个字)