1

我正在为 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. 没有日期或日期格式。即使我删除了这些评论，也没有任何效果；得到同样的错误。有人可以帮我解决这个问题吗？

4

2 回答 2

9

我通过更改我的评论格式来修复它：

/**
 *
 */

到

/*!
 *
 */

我的标题评论如下：

/*!
 *  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
 */

它解决了这个问题，但我不知道为什么以前的评论格式不起作用。（两者都对 headerdoc 有效）

于 2014-12-23T22:32:55.277 回答
7

在执行 headerdoc2html 时添加 -j 选项以同时处理 java 样式注释 ( /** )

于 2016-03-19T19:37:51.720 回答