问题标签 [documentation-generation]

我有一个要为其部署站点的多模块项目，但似乎我的站点部署配置没有被子项目子模块继承。

• 父母
  • 模块A
  • 模块B

在文件系统上，它们彼此相对：

当我运行时：

我的父项目已正确部署到：

• scp://devServer/documentation/webwars/

但是如果子模块继承父distributionManagement，则没有像moduleA或moduleB这样的子项目部署在那里：

• scp://devServer/documentation/webwars/moduleA
• scp://devServer/documentation/webwars/moduleB

这是我的父 pom.xml，我删除了一些无关的细节和报告插件（我包括我的 javadoc 插件，它使用 APIViz 和聚合有点时髦，以确保聚合父 javadocs 和子 javadocs 正确使用 APIViz。）：

我已经尝试在每个子项目模块中定义显式分布管理，除了由于某种原因子项目站点没有 index.html 之外，这些模块可以正确部署？

我没有任何 src/site/ 文件，例如 src/site/site.xml 或 src/site/apt/index.apt。

我想做这样的事情：

但答案是：None……为什么？

Sphinx 是一个 Python 库，用于从一组 ReST 格式的文本文件生成漂亮的文档。不是用于全文搜索的工具

我也完全了解 doxygen / phpdoc 工具。我想弄清楚是否有一种方法可以使用 Sphinx 来记录 PHP 项目？甚至任何其他非 Python 语言？

https://www.sphinx-doc.org/en/master/

我正在用注释装饰我的 C# 代码，以便生成 HTML 帮助文件。

我经常声明和记录接口。但是实现这些接口的类可以根据实现抛出特定的异常。

有时，客户只知道他正在使用的接口。我是否应该通过添加可能由其实现者抛出的异常来记录我的接口？

我应该创建/记录自定义异常，以便接口实现者抛出这些而不是框架的那些吗？

我希望这很清楚！

谢谢

编辑 2010 年 1 月 4 日：我决定在http://blog.mikecouturier.com/2010/01/creating-custom-exceptions-in-net-right.html上写一篇关于 .NET 和自定义异常的博客文章

如何将 RTF 文件转换为 PDF 文件？我有 adobe PDF 打印机，我应该使用它吗？如果是这样，我如何以编程方式访问它？

许多工具可用于 Web 服务设计、编程和测试，无论是商业的还是免费的。但是在文档领域有什么可用的？是否有工具可以解析 WSDL，然后在 HTML（或 PDF）中生成“人类可读”文档？

我们正在管理一个 C++/C# 库，我们注意到许多类和函数没有记录在案。

我们考虑编写一个脚本来解析代码以查找未记录的类和方法以生成未记录的类/方法/函数的列表。

我们还希望将 dOxygen 标记放置在缺少文档的位置的脚本。即如果找到这样的代码：

它将被替换为

当然，如果该函数将来有一个自动生成的文档标题但没有人触及该标题，它仍然会在报告中报告为未记录。

您将使用哪种脚本语言来开发这样的工具？

安东尼

Objective C 是否有一个类似于 JavaDoc 的文档框架，可以从源代码生成文档？

可能重复：
自动生成 PHP 文档？

我是 PHP 新手，我目前的工作要求我以极快的速度学习这门语言。

我是一个文档坚持者。我什至喜欢写文档。我熟悉几种语言的公认文档语法和工具。

这不是 PHP 的情况。

我知道编写可文档化的源代码注释总是有多种方法，并且每种语言通常都有各种工具。但是，我所处的环境没有规定标准的评论方式，也没有标准的 PHP autodoc 工具。这给了我选择的自由，并伴随着一些分析瘫痪。

phpDocumentor ( http://www.phpdoc.org/ ) 是 PHP 自动文档可接受的标准工具吗？

在记录 PHP 代码时是否可以遵循代码的一般 JavaDoc 准则？

Visual Studio 是否可以选择为 Javadoc 样式的注释生成 html 文档？如果是这样，需要哪些步骤来完成此操作？

在 BlueJ 中有一个选项可以将 Javadoc 样式的注释转换为 html 文件。

如下图所示，使用 BlueJ 的 Java 我想对 Visual Studio 做同样的事情：（_{来源：time-tripper.com）}