标签: documentation-generation

我将使用Sandcastle生成API文档 - 我找不到任何有关如何在该网站上执行此操作的指南.有没有人有他们推荐的快速入门指南？

有没有免费体面的程序来为java做代码文档？很难完成编码项目,然后还需要花时间编写文档.如果你知道,请告诉我.

默认情况下,Javadoc不会将源代码放入其生成的html文件中.

我想知道是否可以将源文件放入或超链接？

我正在为iOS应用程序开发一个可重用的API组件.我已经完成了API并将其记录下来以headerdoc供将来的用户使用.

现在我想为这些头文件创建HTML页面.所以我在我的项目目录中的终端中执行了以下命令

headerdoc2html -o ~/Desktop/My_Project_Documentation APIFolder/

但是没有创建文档,而是我收到的错误如下:

Skipping. No HeaderDoc comments found.
No default encoding.  Guessing.  If date formats are wrong, try
specifying an appropriate value in the LANG environment variable.
...done

我尝试了各种方法和方法,最后我缩小了问题的范围:

在我的项目开始时,我有类似的东西:

/**
 *  DarkPantherConstants.h
 *  Panther
 *  Created by Midhun on 05/11/14.
 *  Copyright (c) 2014 Midhun. All rights reserved.
 *  Panther Constants are defined in this header file
 */

所以问题在于这个特别的评论,实际上这个评论是由XCode自动生成的,我实际上修改了名称和评论格式headerdoc.没有日期或日期格式.即使我删除这些评论,也没有任何作用; 得到同样的错误.有人可以帮我解决这个问题吗？

我有一个异步 Spring MVC 控制器，它返回Future. SpringFox 2 将其呈现为：

如何删除它？先感谢您！

我认为它会是这样的（伪代码）：

var pars = new List<string>();
string par;
while (not eof("Platypus.html"))
{
    par = getNextParagraph();
    pars.Add(par);
}

... getNextParagraph() 查找下一个"<p>"并继续，直到找到"</p>"，烧毁其后面的桥梁（“剪切”该段落，以便不会一遍又一遍地找到它）。或者一些这样的。

有人知道如何准确地做到这一点/更好的方法吗？

更新

我尝试使用 Aurelien Souchet 的代码。

我有以下用途：

using HtmlAgilityPack;
using HtmlDocument = System.Windows.Forms.HtmlDocument;

...但是这段代码：

HtmlDocument doc = new HtmlDocument();

是不需要的（“此处无法访问私有构造函数'HtmlDocument' ”）

此外，“doc.LoadHtml()”和“doc.DocumentNode”都给出了旧的“无法解析符号'Bla'”错误消息

更新2

好吧，我必须在前面加上“HtmlAgilityPack”。从而消除了含糊的参考。

我尝试使用apidocjs创建API文档,在编译用于在项目文件夹上使用apidoc.json创建apidoc的项目时出现问题.

代码在这里:

~$ apidoc -i ./ -o apidoc/

结果

warning: parser plugin 'param' not found.
error:   Error: Can not read: apidoc.json, please check the format (e.g. missing comma).

请有人帮我解决这个问题

与apidocjs.com相关的标签