ios - HeaderDoc不生成HTML文档

Question

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

Answer 1

我通过从以下方式更改评论格式来解决此问题:

/**
 *
 */

至

/*!
 *
 */

我将标题标为:

/*!
 *  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有效)