Objective-C - 文档头而不是代码文件？
我想开始正确记录我的代码，但不确定将其放在哪里以供 HeaderDoc 阅读。我在 HeaderDoc 文档中阅读了 以下短语< /a> 这让我觉得预期的位置（从苹果的角度来看）是在头文件中？
如果您愿意，您可以指定输入目录，而不是指定单个输入文件（如上所述）。 HeaderDoc 将处理输入目录（及其所有子目录）中的每个 .h 文件，为每个包含 HeaderDoc 注释的标头生成 HTML 文件的输出目录。
这是对的吗？我放置文档的位置是否会有所不同？
I would like to start documenting my code properly, but am unsure where the best place is to put it for HeaderDoc to read. I read the following phrase in the HeaderDoc documentation which makes me think the intended location (from Apple's point of view) is in the header files?
Instead of specifying a single input file (as above), you can specify an input directory if you wish. HeaderDoc will process every .h file in the input directory (and all of its subdirectories), generating an output directory of HTML files for each header that contains HeaderDoc comments.
Is this right? Does it make a different where I put my documentation?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论