如何正确记录python枚举元素？
我知道我可以像其他任何类一样将Python docstring添加到枚举类型。但是，如何向该类型的元素添加文档？ 据我所知，存在三种可能性： class MyEnum（Enum）： “”“ 这是我的枚举类型。 ”“” “”“ 变体1 ”“” a = 0， b = 1，＃变体2 c = 2，“”“变体3”“” 但是它们中的任何一个都不能真正连续地工作。
..
documentation相关内容
继承C＃中的文档？
在Java和Eclipse中，我习惯使用 @inheritDoc 来允许使用与基类/方法相同的文档。 如何在C＃和Visual Studio 2010中完成类似的工作？ 解决方案 它不存在在香草VS。最好的选择是ghostdoc或类似工具。可在扩展管理器中找到，也可以在此处
..
如何设置Doxygen的输入目录？
我有一个目录，其中保存了所有源文件和头文件。我想运行Doxygen为这些源代码生成文档。但是，我不想更改此目录中的任何内容（特别是我无法添加将在其中保存Doxygen文档的子目录）。 如何实现我的目标 我认为我需要执行以下操作： -我创建并转到“ documentation”目录。 -在此目录中，执行 doxygen -g 创建一个名为“ Doxyfile”的模板配置文件。 -然
..
在Godoc中需要什么步骤来记录`package main`？
Godoc是一个很好的文档包工具，但是当它与 package main 一起使用时，它似乎没什么用。我将看到一个输出，仅显示使用 // BUG 和子目录写给自己的笔记。 Godoc仅显示导出的功能，似乎无法显示main中的未导出的功能。我会发现查看main函数列表很有用。由于不支持此功能，因此我倾向于在软件包说明的顶部插入一个功能列表，但这感觉像是一种解决方法。 因为我必须手动更新在函
..
如何配置Sphinx有条件地排除某些页面？
使用Sphinx生成文档时，我希望能够生成两个版本的文档：一个包含所有内容，一个仅包含一组特定页面。实现此目标的最佳方法是什么？ 我可以编写一个构建脚本来移动文件以实现此目标，但是如果有一种方法可以告诉狮身人面像，那将非常好在特定构建期间排除或包含特定文档。 解决方案 only 和 ifconfig 指令可以用于在页面内应用条件。 似乎没有简单的方法可以完全排除整个页面（.rs
..
链接到R中的roxygen2中的文档中的其他软件包
我想知道是否存在一种方法，当我尝试使用为新软件包编写文档时，可以通过 link 从其他软件包运行roxygen2 。 类似于 \link {pck = PACKAGE_NAME，fun = FUNCTION_NAME} 吗？ 解决方案 您必须输入 \link [pkg] {function} 例如 \link [stringi] {stri_c}
..
禁用“文档注释”；警告所选文件
Xcode可以检查文档注释问题，并在出现不正确的情况时报告警告。例如，我已经使用CocoaPods将Facebook SDK添加到了我的项目中。在文件 FBError.h 的某个位置，有以下代码： / *！ @typedef NS_ENUM（NSInteger，FBErrorCategory） @ abstract指示错误的Facebook SDK分类 @ discussi
..
Slate vs Swagger-哪个更好，哪个有更多选择？
我必须记录我的API。我必须使用其中任何一个 Slate 或 Swagger 。我想知道哪个有更多的选择，利弊，哪个更好。 解决方案 Swagger和Slate提供两种不同的选择目的。 Swagger是尝试以一种描述RESTful API的标准化方式（例如，类似于 ApiBlueprint ） Swagger是基于JSON的API定义格式，用于描述REST API。 〜 API
..
JSDoc中对象中任意键的值的文档结构
我有一个函数 factory ： function factory（events）{ for（事件中的常量键）{ const {之前，之后} = events [key] } } 其中参数 events 通常是： {仅 ：{ before（）{} after（） {} }， 除外：{ before（）{} after（）{} }， }
..
Roxygen2：重载R基本函数（cor）时记录用作S4的S3类
我具有以下上下文： 我确实重载了 cor 基本函数，因此我将其包含在包中声明后的.R文件： ＃'export setGeneric（“ cor”） 现在我想为我的对象创建一个特定的函数（名为 stranger 的类）-为简单起见，我只考虑我的对象是data.table，其中包含名为 .id 的附加列。 ＃'陌生人对象的相关性 ＃'describeIn cor
..
代言人
如何在警告语中进行替换？ 例如： | p |帐户 ..注意：: **使用| p | ** 在我的狮身人面像conf.py中，我定义了替换规则|解释|到解释之前的第一个文件（至少这是我的理解）： rst_epilog ='.. | p |替换：： Labnext’ 我在本段中的第一个替换操作没有失败。但是，note指令中的替代项
..
昂首阔步的交互式HTML
我正在尝试使用“尝试”按钮创建一个html。 swagger-code gen或swagger-ui都给我这个结果。您有任何建议吗？ 解决方案 您可以尝试更改将Swagger UI 转换为“一个大的HTML杂乱文件”，如下所示： 下载Swagger用户界面（链接到最新的母版）。 转到 dist 文件夹。 编辑 index.html 如下： 删除
..
如何编写内部API的文档测试？
我正在写一个包含私有结构和方法的库： ///构造一个新的`Object` /// ///内部API /// ///＃示例 ///```rust /// use lib :: object :: Object; /// ///让tn = Object :: new（）; ///``` 当我运行货物测试时，文档测试失败，因为 Object 是私
..
就像Doxygen在C ++中一样，Roxygen真的可以记录R脚本（不是软件包）吗？
Roxygen受到C，C ++程序员使用的Doxygen文档系统的启发。我已经使用过Doxygen，只要您有doxygen注释，我发现记录任何程序真的很容易。它还会为函数和类生成调用图。我以为roxygen会以相同的方式工作，但是当我搜索roxygen帮助时，我只找到记录R包的解决方案。 我已经检查了Hadley Wickham的在线 roxygen2 help ，但这并没有描述有关R脚本文
..
如何编写整箱的文档？
为了确保记录我的板条箱中所有公共物品（如果最少要从头开始），我在我的＃！[deny（missing_docs）] code> lib.rs 。 我希望在顶部和之后的代码中写文档注释： /// Rust的Hello world示例。 ＃！[deny（missing_docs）] fn main（）{ println！（“ Hello world！”）; }
..
如何使用Doxygen在C ++函数中记录局部变量
例如，在我的函数中 //以doxygen文档开始代码 / **主要功能。我现在将尝试在此main函数中记录变量* / int main（） { int arr []; / ** \简述一个整数数组* / ..... 返回0; } //代码结尾 但是，当我将Doxygen与在配置文件中将“ HIDE_IN_BODY_DOCS”变量设置为“ NO”，则不会
..
有没有很好的方法来生成swig接口文档？
我想知道是否有任何好的方法可以在界面上构造/维护 文档。 我正在从以下位置构建界面使用swig的python的c ++代码;大部分我只是 ％，包括c ++头文件。我正在处理至少几十个 类和100多个函数，因此首选自动化工具。 理想情况下，我想使用doxygen在c ++标头中格式化为 的注释会填充python类/方法中的文档字符串。 或者，生成单独的文档（使用ascii，
..
如何在Python中记录模块？
就是这样。如果要记录函数或类，请在定义之后放置一个字符串。例如： def foo（）： “”“此函数不执行任何操作。”“” pass 但是模块呢？如何记录 file.py 的作用？ 解决方案 对于软件包，您可以记录放在 __ init __。py 中。 对于模块，您可以在模块文件中简单地添加文档字符串。 所有信息都在这里： http://www.p
..
使“文档问题”静音Xcode中的警告？
例如 '@ param'命令用于未附加在函数声明中的注释 此警告是有效的，但是，我正在编译第三方代码，并且希望不必更改原始源。 我正在运行Xcode 8.2.1。 解决方案 我能够通过 项目来隐藏这些警告->构建设置-> Apple LLVM 8.1-警告-所有语言，然后将“文档注释”切换为否。 （要查找设置，我在“构建设置”下的搜索框中键入了“文档”。）
..
不要使用p6doc显示声明符块
我编写了一个小示例文件来了解有关Perl 6 POD的更多信息，并且我正在使用 p6doc 从POD文档中呈现一个小的手册页。但是， p6doc 也会尝试解析POD文档外部的声明符块。在输出中看起来并不特别好。使用 p6doc 时是否可以忽略声明程序块？ 我正在使用的代码示例为： ＃！ / usr / bin / env perl6 使用v6.c; ＃|在命令行上向人们问好
..