问题标签 [documentation-generation]

有没有人使用其他任何东西来记录他们的PHP代码PHPDoc? 是否有任何工具可以读取相同的文档语法但提供更丰富的输出？

对于 ActionScript 2，我使用了 NaturalDocs。但是它对 PHP 的支持很差。到目前为止，我已经看过doxygen和phpDocumentor，但在我看来它们的输出非常丑陋。有人对 PHP 的自动文档生成有任何经验吗？我更喜欢能够使用 javadoc 风格的标签，它们写起来很短，而且很容易记住。

我是一所主要用 Java 教授的学校的大学生。我非常喜欢 Java 的优势之一，就是大量的库集合。使这些库特别有用的是通过 JavaDoc 提供的大量文档和组织。是否有任何具有这些特性的 Common Lisp 库集合，是否有类似于 JavaDoc 的工具可以帮助构建、维护或扩展这些库？

如何在 .Net 中记录内联成员？让我解释。大多数从注释中提取文档的工具都支持某种内联文档，您可以在其中在成员声明之后添加简要说明。就像是：

有没有办法在 C# 或 .NET 语言中做到这一点？

我注意到 doxygen 使用 graphviz 库来创建图表。你曾经使用过 graphviz 来生成文档吗？出于 doxygen 范围之外的文档目的而学习 graphviz 是否值得？还是我最好坚持使用像 Visio 这样的标准数据建模包？

我理解它作为图形库的优点，但是为了尝试表示更复杂的 UML（或类似的），它仍然值得研究吗？

早上好，下午，晚上或晚上（取决于您的时区）。

这只是关于 C# 中 XML 注释的一般问题。我从来没有非常热衷于评论我的程序，我一直是一个冗长的变量/属性/方法命名器，让代码自己说话。如果我正在编写相当混乱的代码，我会写评论，但在大多数情况下，我不会写很多评论。

我正在阅读 .NET、Sandcastle 中的 XML 注释和 codeplex 上的帮助文件生成器，它让我走上了想要记录我的代码并为那些必须深入研究我的人生成一些很好、有用的文档的道路。当我不再在这里时的代码。

我的问题是关于标准和约定的。是否有“好的”XML 注释指南？你应该评论每一个变量和属性吗？每种方法？我基本上只是在寻找有关如何编写好的注释的提示，这些注释将由 sandcastle 编译成好的文档，这样其他程序员在最终不得不处理我的代码时就不会诅咒我的名字。

提前感谢您的意见和建议，Scott Vercuski

如果您有一个被描述为 C 结构的二进制文件格式（或数据包格式），是否有任何程序可以解析该结构并将其转换为您的协议的整洁文档？

该结构当然会包含数组、其他结构等，这是描述格式所必需的。文档可能需要包括打包、字节顺序等内容。

我正在编写一个应用程序，除其他功能外，它还生成 MSSQL 数据库（对象、表、表数据）的 MediaWiki 文档。

我的问题是您喜欢或需要制作哪种文档格式。我有太多想法要遵循，所以你的回答应该确定我的优先级；）

（我知道在 SO 上还有其他与文档相关的问题，但它们主要涉及如何生成文档（我知道如何），并且不要求特定的文档类型或平台）

编辑：感谢您的评论。实际上我已经有了表关系，因为我解析了外键。但是完整的交叉引用可能有点棘手；）

但是，该问题旨在询问文档类型，例如 Word、PDF、ODF 等。您的专业要求或偏好是什么？

更新： 生成的文档概述

是否可以在 Eclipse（3.4 w/CDT）中记录 C 代码，以便自动生成和显示类似 JavaDoc/Intellisense 的文档？

例如，在键入函数名称后跟一个“（”时，您会得到第一个参数，其中包含解释该参数含义的工具提示？

谢谢。

用于记录 python 源代码的约定和工具有什么？