Documentation Framework like JavaDoc for Objective C

安稳与你 提交于 2019-12-03 11:06:29

问题


Does Objective C have a documentation framework similar to JavaDoc where documentation can be generated from the source code?


回答1:


Doxygen! You can use it for many languages, including Objective-c




回答2:


Good news for all! :D Finally after waiting a long time Apple has introduced a parser comments for our projects. According to the new features in XCode 5:

Project documentation from framework API reference documentation and structured comments in your own source code are displayed in the quick help panel and in code completion popover views. Doxygen and HeaderDoc structured comments are supported formats.

and from the Clang 3.2 release notes:

Clang parses the comments and can detect syntactic and semantic errors in comments. These warnings are off by default. Pass -Wdocumentation flag to enable warnings about documentation comments.

If you want to see an example of this new feature I recommend you take a look at the following article: Documentation in Xcode 5




回答3:


Doxygen is quite popular among Obj-C developers.




回答4:


You could have a look to HeaderDoc wich is the apple documentation framework similar to Java.




回答5:


Appledoc has become very popular. . . version 1 was based on Doxygen, whereas version 2 was written from the ground up.

It doesn't quite have all the features of Doxygen (charts, enums, C++ classes, etc), but what it does offer is beautifully formatted docs in HTML of IDE integrated format.

Also interesting to note is the following:

  • The CocoaPods tool includes Appledoc documentation for the libraries that it installs. Quite handy.


来源:https://stackoverflow.com/questions/1911427/documentation-framework-like-javadoc-for-objective-c

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!