文章/答案/技术大牛

发布

社区首页 >问答首页 >不生成HeaderDoc文档的

问不生成HeaderDoc文档的
EN

Stack Overflow用户

提问于 2014-12-23 22:15:21

回答 2查看 1.5K关注 0票数 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。没有日期或日期格式。即使我删除了这些注释，也没有任何效果；得到的错误也是一样的。有人能帮我解决这个问题吗？

ios

objective-c

xcode

documentation-generation

headerdoc

回答 2

Stack Overflow用户

回答已采纳

发布于 2014-12-23 22:32:55

我通过将我的评论格式更改为：

/**
 *
 */

至

/*!
 *
 */

我的标题评论如下：

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

票数 9

Stack Overflow用户

发布于 2016-03-19 19:37:51

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

票数 7

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/27628803

复制

相似问题

问不生成HeaderDoc文档的
EN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问不生成HeaderDoc文档的EN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问不生成HeaderDoc文档的
EN