Doxygen与文档注释

目录

Doxygen与文档注释

Doxygen

简概

• 简概
  • 开源跨平台的，以类似JavaDoc风格描述的文档系统
  • 是一个程序的文件产生工具，可将程序中的特定注释转换成为说明文件
• 兼容性
  • 完全支持C、C++、Java、Objective-C、IDL 语言
  • 部分支持PHP、C#
  • 注释的语法与Qt-Doc、KDoc和JavaDoc兼容
• Doxygen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。

注释风格

1. JavaDoc类型的多行注释。
2. QT样式的多行注释。
3. /// …text….
4. //! …text….

javadoc

javadoc 标签

javadoc 标签

javadoc 工具软件识别以下标签：

标签	描述	示例
@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
	插入一个到另一个主题的链接
	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样	The @throws tag has the same meaning as the @exception tag.
	显示常量的值，该常量必须是static属性	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

注：加粗表示常用

其他常用：

• @brief xxxx，简要
• @update: [序号][日期YYYY-MM-DD] [更改人姓名][变更描述]，更新

javadoc 文档注释

在开始的/**之后，第一行或几行是关于类、变量和方法的主要描述。

之后，你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*).

多个相同类型的标签应该放成一组。例如，如果你有三个 @see 标签，可以将它们一个接一个的放在一起。

下面是一个类的说明注释的实例：

/**
 * 这个类演示了文档注释
 * @author Ayan Amhed
 * @version 1.2
 */

Python注释

写法区别较大，具体去看Python相关笔记

文档字符串

写法区别较大，具体去看Python相关笔记

函数注释

写法区别较大，具体去看Python相关笔记