问题标签 [documentation-generation]

在 C# 中，我可以使用XML Documentation Comments直接在代码中附加属性、方法、事件等的文档。

我知道如何插入对特定方法的引用：

有没有办法插入对方法组的引用？我有多个相同方法名称的重载......

我试过了

..但这没有用。

编辑：凹凸

我有一个打印一些信息的 php 页面。信息是一个表格，在表格单元格中动态打印了一些值。现在，我不想将此页面发送到浏览器，而是希望将页面导出到 word 文件。我该怎么做？

总之我有一个页面A.php。A.php 包含指向B.php. 单击链接时，A.php我希望将文件导出到 ms word 文件(*.doc).浏览器应显示“另存为”或“打开”框。

我过去习惯于通过更改一些标头来实现jsp。但是我怎样才能在 php 中实现上述功能呢？

我们知道 UML 包含 13 种类型的图（结构图和行为图）

在开始软件开发之前，我们处于需求和设计阶段，那么应该创建哪个图表以及何时创建？.. UML 在需求和设计阶段的图表创建顺序应该是什么？

事实上，如果没有严格的顺序，那么首先我们需要严格地创建结构图，但是像活动图这样的行为可能会根据用户体验而改变？

我们可以单独创建一个部署图和组件图吗？

这是一个烦恼多于一个问题。我的项目包含许多自动生成的文件（使用 mgmtclassgen.exe）。当我生成 XML 文档时，我的精美注释库受到来自这些 autogen 文件的 xml 文档警告的困扰。

有没有办法a）禁止为这些文件生成文档或b）只为一组文件禁止警告CS1591？我显然不想修改自动生成的文件，即使只是添加抑制编译指示。

库和生成的代码都在 C# 中，我使用的是 Visual Studio 2008。

最近，我一直在研究 Apache Forrest 作为代码文档解决方案。从 Apache 的网站，

“Apache Forrest™ 软件是一个发布框架，它将来自各种来源的输入转换为一种或多种输出格式的统一表示。Apache Forrest 的模块化和可扩展插件架构基于 Apache Cocoon 和分离表示的相关行业标准来自内容。Forrest 可以生成静态文档，或用作动态服务器，或通过其自动化设施进行部署。”

我想知道是否可以使用 Apache Forrest 作为一种方式来组织和发布一些带有 JavaDoc 注释的 Java 代码的文档。我知道 JavaDoc 可以自己完成，但我觉得 Apache Forrest 提供了一些额外的自定义。我在 Apache 网站上找到了有关如何将其包含在 Maven 中的说明，但它似乎是针对 Maven 1.x 量身定制的，我使用 Maven 2。这样的事情可能吗？如果是这样，集成它的最佳方法是什么？

提前谢谢。

有没有免费的像样的程序来为java编写代码文档？完成编码项目已经够难了，然后还需要花时间编写文档。如果你知道，请告诉我。

我有一个继承 flash.display.Sprite 的 API。当我尝试为 API 生成 ASDocs 时，ASdoc 显示我的类继承自 flash.display.Sprite，但没有链接或没有指向Sprite 的 ASDoc。谁能告诉我我错过了什么。

我在我的 ant 脚本中使用的命令是

在此先感谢您的帮助。

我正在寻找 .NET 的 XSD 文档生成器。请提供任何参考资料。

注意：如果它有源代码，那将是更好的选择。

谢谢。

我们每个月都使用 Stata 来合并和分析我们在一个地区的所有机构的数据。我想以某种方式为这些月度报告自动创建数据分析报告。该报告包括一个报告指标的汇总表、几个关键指标的图形以及一个显示数据组在统计上显着差异的分析表。我希望这些是 pdf 格式并自动通过电子邮件发送给代理机构。关于我可以用来自动执行此操作的软件的任何想法？

我想知道是否有任何明确的理由选择UmlGraph而不是APIViz在 Maven2 构建中生成 javadoc UML 图。是否有任何集成或功能，它们看起来非常相似？