我正在寻找一种工具，即使没有适当格式的注释块与这些函数或属性相关联（像Doxygen一样），也可以生成JavaScript函数和属性的文档。 这篇关于JSDoc和其他文档工具的比较的文章提到，JSDoc可以解析源代码以生成文档，即使没有注释块（就像我上面提到的Doxygen一样）。他们说所有...

我正在寻找一款免费工具，可以生成关于数据库模式、表格、列、键、指数的文档，并以PDF或HTML格式呈现，就像商业工具"Toad Data Modeler"一样。 我正在使用Postgresql 9.2。 你能否推荐一些文档生成器？ 谢谢， 尼科

我们不希望像维护源代码那样维护文档，因为源代码正在快速发展，但是 Sphinx 似乎需要大量的设置和配置，这让人感到沮丧。（我们只需要一些基本的 API 文档。）难道没有一个单独的命令可以在 python 项目内运行，然后迭代所有包、模块、类和函数并生成 HTML 文档吗？ sphinx-a...

早上好，下午好，晚上好或晚安（根据您所在的时区而定）。 这只是关于C＃中XML注释的一般性问题。我从来没有非常重视对我的程序进行注释，我通常更喜欢用冗长的变量/属性/方法名称让代码自己说明。如果我编写的某些内容相当混乱，我会写注释，但大多数情况下我不写很多注释。 我正在阅读有关.NET、S...

我正在用注释来装饰我的C#代码，以便我能生成HTML帮助文件。 我经常声明和记录接口。但是实现这些接口的类可以根据实现抛出特定的异常。 有时，客户端只知道使用的接口。我应该通过添加可能由其实现者引发的异常来记录我的接口吗？ 我应该创建/记录自定义异常，以使接口实现者引发它们，而不是框架的...

gRPC支持生成类似Swagger的服务文档吗？

有许多优秀的工具可用于源代码和API文档（例如doxygen、Headerdoc、Sphinx等），但是它们似乎都不擅长为通过RPC接口提供的API生成文档（如果您有关于如何使用这些工具综合RPC API文档的建议，请尽管提出）。 我特别感兴趣的是至少在某种程度上支持JSON和AMQP的文档...

我希望将行内注释尽可能缩短，因为我的经验是超过3或4行的注释往往会被忽略，从而产生许多不必要的“读取手册行”。 由于遗留问题，我需要遵循与jsdoc兼容的代码文档格式。它要求将许多自明的内容显式声明，以便正确地记录它们。事实上，几乎每个标签都可以归入这一类别。即使没有，对于工作中的开发人员...

我希望生成一个自定义JSF 2组合组件库的文档。这些组合组件没有在任何faces-config.xml文件中被引用，而是将组合组件的.xhtml文件存储在META-INF/resources中，并使用新的composite:interface标签来定义接口。 对于JSP标签库，可以使用htt...

我正在尝试使用自动化文档工具为Tastypie REST API生成API文档。我尝试了Tastytool，但它似乎只显示模型的列而非API的结果参数。然后我尝试使用Sphinx，因为Tastypie支持Sphinx，但是我无法找到如何在代码中添加API注释并将其生成到文档中的示例。 有人可...