最近,我一直在研究Apache Forrest作为代码文档解决方案.来自Apache的网站,
"Apache Forrest™软件是一个发布框架,它将来自各种来源的输入转换为一种或多种输出格式的统一表示.Apache Forrest的模块化和可扩展的插件体系结构基于Apache Cocoon和相关的行业标准,将表示分开来自内容.Forrest可以生成静态文档,或者用作动态服务器,或者由其自动化工具部署."
我想知道Apache Forrest是否可以用作组织和发布一些Java代码的文档的方法,这些代码与JavaDoc注释一起完成.我知道JavaDoc可以自己做,但我觉得Apache Forrest提供了一些额外的自定义.我在Apache网站上找到了如何将其包含在Maven中的说明,但它似乎是针对Maven 1.x而定制的,我使用Maven 2.这样的事情可能吗？如果是这样,那么整合它的最佳方式是什么？
提前谢谢.
如果我有一个基于REST的服务,用Symfony [symfony-project.org]框架(即PHP)编写,那么是否有任何不错的工具/框架可以解析我的代码并生成API文档？
基于Java的框架包含类似于我需要的文档功能,您可以在此处查看此示例:http://enunciate.codehaus.org/wannabecool/step1/index.html.
我理解基于REST的服务的前提应该是不言而喻的,但是我想要为我生成这个文档的东西,而不需要手动写出我的所有端点,支持的格式,样本输出等.
谢谢
我正在使用Sphinx的"手动"文档类,我对Latex输出的外观非常满意,除了页眉.它包含我的论文标题,以及"Release 1".
由于我正在撰写论文而不是文档,因此我显然不需要发布信息.不幸的是,很难找到有关如何定制Sphinx乳胶输出的信息.
有人知道怎么做吗？
我使用doxygen和XML文档注释为我们的框架库创建内部API文档.
Doxygen为每个命名空间创建一个"包".我想知道是否有可能在命名空间级别添加源文档以显示在Doxygen的包视图中？
我目前正在创建一个 phonegap 应用程序，让您输入数据，然后使用该数据创建 PDF。输入已完成，但我找不到任何可以使用 Javascript 制作 PDF 的内容。到目前为止，我只找到了 jsPDF，但它不支持表格。该应用程序必须离线工作。有人有想法吗？
Doxygen 有\todo命令，该命令生成的文档显示在它所在的函数中，并聚合到一个全局 Todo 列表文档中。
可以为任意其他标签复制或模拟这种行为吗？我想做类似“\tag XXX”之类的操作，并将该评论汇总到一个全局“XXX 列表”文档中。
我该如何命名Doxygen @ref标签？
我尝试了以下方法：
See @ref hello_world hello for more information
输出以下内容：
See hello_world hello for more information
hello_world链接到哪里hello_world。我正在寻找此输出：
See hello for more information
hello链接到哪里hello_world。Doxygen的文档仅包含有关@ref（\ref）的LaTeX形式的信息，并且我不知道如何将其应用于JavaDoc样式@ref。
我将如何更改链接的“文本”值？
基于这个问题Multiple arguments vs. options 对象
我想知道这如何适用于 Typescript。我想做出这样的决定：
我现在发现的利弊：
Typescript 可以很好地处理可选参数，但是我觉得依赖参数的顺序和拥有一长串参数并不方便。
option对象的使用很好，但需要为每个对象创建一个接口（？），在我的理解中，这会导致代码过载，我不知道会生成哪种文档/提示。
arguments parameter-passing documentation-generation typescript
我在 DocFX 配置中缺少一些东西 - 所以它不会生成正确的文档。
我有以下文件夹结构：
+Documentation
|- _site
|- api
|- apidoc
|- articles
|- images
|- src <-- This folder is autogenerated by `docfx init` command as a folders above
docfx.json
index.md
toc.md
+packages
|- Microsoft.NETCore.Platforms.1.0.1
|- ... other nuget folders
+src
|- MyRealProject
|- assets
|- bin
|- Commands
|- obj
|- Properties
|- vendor <- This folder should be excluded for documentation
app.config
MyRealProject.csproj
MyRealProject.csproj.user
Program.cs
+test
|-MyRealProjext.XUnit
|- bin
|- obj
|- Properties
app.config
.gitattributes …我有一个非常大的.java类文件，其中包含很多成员。如何为此创建HTML文档，以便按外观顺序显示成员，而不按成员类型排序？（方法，常量和变量）
例如，如果我的Java代码是：
private int typeOfAction_1; // notice the order: 1,2,3..
public void startAction_2(){
}
private int jobtype_3;
private int jobcount_4;
private void doJob_5(){
}
public void haltAction_6(){
}
订单的Javadoc成员按字母顺序和按类型排序，因此，成员之间的关系都将丢失：
int jobcount_4; // notice how the order is lost: 4,3,1..
int jobtype_3;
int typeOfAction_1;
doJob_5()
haltAction_6()
startAction_2()
此外，是否生成具有更智能功能的文档？喜欢：