问题标签 [documentation]

是否有可以记录类似于 JavaDoc 生成的 shell 脚本的开源或公共领域框架？我不需要将其仅限于特定风格的 shell 脚本，理想情况下，我想要一个用于在网页上记录 API 或命令行类型命令的通用框架，该框架易于扩展，甚至更好的是自我记录。

我刚刚从 CACM 的一篇文章中意识到 Doxygen 也可以与 Java（和其他几种语言）一起使用。但是Java 已经有了Javadoc 工具。有人可以解释这两种方法的优缺点吗？它们是相互排斥的吗？Doxygen 有 Maven 插件吗？

Visual Studio 做到了；反射器做到了；现在我也想要:)

我想检索某些框架程序集中的某些成员的 XML 文档（即mscorlib.dll，System.dll等）。我认为这将涉及：

• 查找程序集的 XML 文件，
• 导航到适当命名的子元素，以及
• 检索所需的项目 ( <summary>, <remarks>, 等)

框架程序集的 XML 文件保存在哪里？关于破译 XMLDOC 命名方案的任何要点？是否有任何图书馆可以使这个过程更容易？

我正在努力规范我的项目并在一开始就创建一个愿景/范围文档。其中包括用例图。仅仅列出用例确实帮助我充分了解了客户要求的所有需求，并且打开了对话。

我想知道用例应该有多详细。如果我正在制作一个 Web 应用程序并且用户将登录以查看报告，我是否会在用例描述中列出报告中的所有列？

如果没有，那么我什么时候会记录这些细节？

在记录方法或类等时，我可能会意外地忘记描述一些参数或异常抛出（或其他东西）。

是否可以以警告我缺少文档项的方式运行 javadoc？

（我使用 ant 脚本生成文档）

Wikipedia 提供了许多在科学中使用的引文，但是在计算机科学和软件工程相关文档中是否有一个突出？我最初的猜测是IEEE 格式，因为他们有许多与这两个领域相关的会议和出版物，但我找不到任何确定的东西。

目前我正在使用 Visual Source Safe（是的，是的！）来存储我的技术规范文档。

实际的文档是用 MS Word 编写的。

如果发现以 word 格式编写规范是一个很大的负担，那么要真正使用规范，就不应该有任何使用障碍，更重要的是访问。

如果我不能快速扫描文档、超链接到其他相关文档或部分，那么这一切有什么用？

因此，以此为背景：

有什么软件可以创建真正可访问的文档？即到其他页面/部分等的超链接？甚至可查询，因此我可以查看依赖于模块 4.5.3 的所有文档

它基本上只是一个维基吗？还要别的吗？

我正在开发一个应用程序，它有很多文本和不同的模块，可以包含或不包含在每个构建中。

对于每个保存的项目，我们会自动生成一份包含所有详细信息的报告（即，该项目中使用的算法的描述等）。目前我们将所有文本作为字符串嵌入到源代码中，我们还通过 po 和 mo 文件支持不同的语言。

该系统的优点是动态生成文档和报告文件非常容易。不好的一点是源代码中有很多文本很难看，格式（即使用html）不舒服，文本编辑很困难，拼写检查不方便，翻译也很糟糕。

所以，最后一个问题是：你是宁愿在代码中嵌入文档还是为不同的语言编写外部文档文件（例如 html）并在运行时解析它们？显然是软件的核心文本，我们这样的消息框无论如何都会留在代码中。

如果重要的话，我正在使用 wxWidgets 使用 C++。

我想使用 Doxygen 来记录混合了 C 和 x86 汇编语言的遗留代码。汇编语言不是内联的，而是在单独的仅汇编文件中。如何记录汇编语言部分？

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

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