小编alb*_*ert的帖子

许多语言都支持文档注释,允许生成器(如doxygenjavadoc或doxygen)通过解析相同的代码来生成代码文档.

Swift有这样的类型文档评论功能吗？

一个Xcode中5的新功能是一种特殊的注释语法来记录自己的代码的能力.格式类似于doxygen,但似乎只支持这些功能的子集.

支持哪些命令,哪些命令不支持？
他们的任何用法与doxygen有什么不同？

我想添加自定义(非项目)文件以使用Doxygen生成一些额外的页面.

我(实际上)不确定应该如何命名这些文件以及如何格式化它们的内容.

对于ActionScript 2,我使用过NaturalDocs.但是它对PHP的支持很差.到目前为止我看过doxygen和phpDocumentor,但是我认为它们的输出非常难看.有没有人有PHP自动文档生成的经验？我更喜欢能够使用javadoc风格的标签,它们很容易编写并且易于记忆.

我想直观地看到类,函数和变量/属性,依赖性,如NDepend,但是对于ActionScript 2或AS3代码.

任何计划或想法？

以某种方式使用doxygen？

的FlexUnit？

哪个C#xml文档注释标记用于文字true,false和null？

在Microsoft自己的文档中,这些文字以粗体显示.例如,属性ArrayList.IsFixedSize的文档显示为:

如果ArrayList具有固定大小,则为true;否则为false.否则,错误.默认值为false.

没有微软推荐的标签似乎适用于这种情况.最佳拟合似乎是<c>,但是在Doxygen呈现文档时会<c>true</c>出现.true

然而,<b>true</b>与Doxygen一起使用产生了大胆的文字,因为我猜测它可能会.但这让我想知道将标准HTML标签与其他文档生成工具(如Sandcastle和GhostDoc)一起使用的可移植性.

Doxygen中\ param [out]和\ return有什么区别？它们似乎都记录了函数的输出/返回.差异是由于void函数没有返回值而只是param[out]有效吗？

我遇到了Doxygen识别命名空间和模块的问题.我认为问题围绕着是\addtogroup在命名空间内还是在命名空间之外.

示例1,在命名空间之外:

/*!
 *  \addtogroup Records
 *  @{
 */

//! Generic record interfaces and implementations
namespace Records
{

  //! Describes the record interface  
  class Interface;

} // End namespace Records

/*! @} End of Doxygen Groups*/

示例2 - 在命名空间内

//! Generic record interfaces and implementations
namespace Records
{
/*!
 *  \addtogroup Records
 *  @{
 */


  //! Describes the record interface  
  class Interface;

/*! @} End of Doxygen Groups*/

} // End namespace Records

我希望它namespace Records出现在Doxygen Namespaces …

我正在寻找一个从我的VS2010 XML文档创建HTML /帮助文件的好工具.我找到了一些商业工具,比如

• .Net文档工具
• VSDocman

我相信还有更多,我只列出这两个例子.还有简单的XSLT样式表,可以将XML转换为HTML文档.

您在使用什么,例如是否有免费工具进行转换,可能是插件.只是为了澄清,基本上我找到了两种工具:

1. 以不同的目标格式转换XML文档文件的那些,这就是我正在寻找的.
2. 帮助我在源代码中生成XML文档的工具.这不是(!)我在寻找的东西.

谢谢你的帮助.

Sandcastle/SHFB组合效果很好.感谢所有帮助过的人.

一些评论:

1. NDoc似乎已经过时,最近的更新是从2005年开始的.这就是我跳过这个的原因.
2. 类似的线程,也非常详细,可以在这里找到:如何将C#Xml Doc-Comments变成有用的东西？谢谢你的暗示!
3. Sandcastle有一些来源,我找到的最新版本位于:http://sandcastle.codeplex.com/
4. 为了生成MsHelp2我不得不安装VS 2008 SDK包含hscomp.exe.有一个版本1.0和1.1,据我所知,版本1.0包含编译器.有关详细信息,请参阅Helixsoft和Social MSDN.
5. 在我的情况下,生成的WebHelp无法与Chrome正常工作.它总是重新加载index.html页面.
6. 此处的主题显示如何将命名空间信息添加到sandcastle文档中.
7. 截至2012年11月的更新:对于我使用Doxygen的小型项目- 我发现它更容易配置.

我测试了Doxygen和多个GitHub项目(jsdoc,react-docgen,react-doc-generator使用npm i -g如下:

react-doc-generator ./ -o DOCUMENTATION.md
react-docgen --pretty -o out/reactdocgen.html ./
jsdoc ./src
doxywizard

但没有人真正理解最近的ES6 JavaScript和JSX for React Native(甚至没有提到本机代码).我最终得到了无用的文档.

当然,我试图添加注释(和don的\ fn),但是注释完全由手工输入(未生成),有时文档中的代码不存在.

/**
 * 
 * 
 * @class MainScreen
 * @extends {Component}
 */
class MainScreen extends Component {
    /**
     * 
     * \fn navigationOptions()
     * @static
     * @memberof MainScreen
     */

最后我没有找到jsdoc文件夹和子文件夹的方法(但是评论文件的测试结果是subpar).

所以我转向React Native文档大师问:如何为React Native生成文档？

如果仅来自评论,您是否有工具从RN + ES6(+ Native)代码生成注释？

加分点:例如,我们可以自动从导入语句中获取图表吗？喜欢: