1.Doxygen
Doxygen可将诉讼程序中的具体评论变成注释。可能取决于程序的结构。(a) 按照议事规则处理发表的评论说明,结果只编写参考手册。通过提取代码结构或自动制作无能地图、继承地图和合作地图,可以说明文件之间的关系。Doxygen能够以多种格式创建帮助文件,包括CHM、RTF、PostScript、PDF、HTML和其他格式。
我不确定,德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧、德氧
2.graphviz
Graphviz(Graph Visualization Software)是一个由AT&T实验室启动的开源工具包,用于绘制DOT语言脚本描述的图形。为了利用多克希根绘制依赖地图、继承地图和合作地图,我们必须首先解决这个问题。首先,必须安装图形viz 程序 。
下载网址:https://graphviz.org http://ww.un.org/download/
3.HTML Help WorkShop
创建 CHM 文件的最佳工具是 微软的 HTML 帮助讲习班 。它通过汇编 HTML 文件生成CHM 文档。默认情况下, Doxygen 程序会创建 HTML 或 Latex 文件 。HTML 将被用于生成 CHM 文档 。然后,必须安装 HTML 帮助 WorldShop 程序 。并连接在多克希根。
下载地址
https://docs.microsoft.com/zh-cn/previous-versions/windows/desktop/htmlhelp/microsoft-html-help-downloads
规范
规范综述
简言之, Doxygen 批注块在 C, C++ 批注块的底部添加了一些额外的标记, 以便让 Doxygen 在输出文档中识别和安排它 。
每个代码项目包含两种描述:一种是简短的,一种是广泛的。两种都是可选的，但不能同时没有。一行对简要说明(简报)作了简明扼要的说明。详细描述(详细描述)将产生一份篇幅更长、更详细的文件。
Doxygen 中的附加说明区块被确认为详细(详细)描述,主要通过下列方式:
从C型评论块中的两个星号开始 *', JavaDoc:
Qt风格的代码评语,C式评语区开头有叹气标志! 我不知道我在说什么
使用两个或两个以上的注释行,每条以额外的斜线或感叹点开始:
类似地,简况也以多种方式说明,例如,强制语句更倾向于@brief 命令,例如:
异常
模块
模块是在不同的网页上安排项目的一种手段。可能该组的成员是档案,namespace，classes，functions，variables，enums，typefs 和定义等但是,其他组织也可能参与。
为了定义一个集团,应该在单独的批注块中进行拆分 。命令的第一个参数应该是识别该组的唯一标签。指定一个城市为特定群体的成员,将指挥组的指挥放在镇子前面组标题是第二个参数。
您可以将组合指令加密, 并避免将其放在每个成员笔记的前面 。 @ 标签可以同时用于组合注释和单独的批注块 。
这些组标记也可以用来筑巢 。
如果组标签被多次使用,将会出错。如果你不想要氧气 强制实施唯一的标签,您可以使用 adtogroup 而不是拆分分组 。其运作方式与分组相同。但是,如果该团体被指明,默认情况下,它会给现有的一个句子添加一个新的句子。在这个序列中,该组的名称是可选的 。也可以考虑使用它。
/*
- @ defgroup 模块名称描述文本
- @{
/
… 定义的内容 …
/* @} */
/ 本单元的结论,以便您可以在别处更详细地将成员加入一个小组。
如果答复(如类别或文件)含有一个以上成员,我们通常喜欢组装Doxygen已经能够根据这些物品的性质和保护程度,自动对这些物品进行分类。然而,你可能认为它不够充分,或者默认方法不正确。例如,你认为应该将各种形式的(语法)分类。
以下是如何定义一个成员群体:
//@{
…
//@}
块或者使用。
/@{/
…
/@}/
注释实例
1.文件注释
注释写在以下示例的代码文档的顶部。您可以查看某些文本名称、作者、电子邮件、版本、日期、导言和版本的完整记录。
2.类和成员注释
/**
- @class <class‐name> [header‐file] [<header‐name]
- @brief brief description
- @author
- @note
- detailed description
*/
如果对文件、结构体、联合体、类或者枚举的成员进行文档注释的话,并且要在成员中间添加注释,而这些注释往往都是在每个成员后面。为此,可以使用在注释段中使用’<'标识。
int var; /**< Detailed description after the member */
以下是某些类别的例子:
3.函数注释
从下面的例子可以看出,我们不以知识来重复这些例子。
当你访问附加说明的网页时,将看到以下内容。
4.枚举注释
从下面的例子可以看出,我们不以知识来重复这些例子。
5.全局变量和宏
6.模块注释
组指定命令的优先级( 从高到低): 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合、 组合defgroup，addtogroup，weakgroup。弱组类类似于低优先增加组。其用意是建立一个“懒惰”集团定义:它可以是。 h 通过以高度优先的方式界定结构,是, 在 cpp 文件中使用弱组以避免重复 。 h 文件的等级结构 。
实际上,我们可以看到所显示的下列网址。
携带驱动器 LED 在 BSP 中由 LED 模块代表。 代码如下, 我删除了该函数的语句以显示其影响 。
如前所述,没有继承的正是C部分,有时要求C++的继承。