我不是要求一个工具,如HeaderDoc,Doxygen,appledoc,....
我想要一种记录不在.h文件中的方法的方法。
我的意思是:我不想在.h文件中记录。
我知道我们可以使用相同的方法在.m文件上记录该方法。 .h文件中的行太多会导致文件在某人看到文件时不易跟踪,因此我将文档移动到.m文件。
但是有一种情况我需要在@protocol中为方法编写文档。它是.h文件,没有.m文件。而且我不想在.h文件中记录,以便在有人看到文件时轻松跟踪。
我看到iOS sdk有一个案例。由于您可以检查内置的@protocol UITableViewDataSource,因此文档不会放在声明中,而是放在某处。
你知道吗?谢谢。
答案 0 :(得分:0)
无论是在头文件,协议还是.m文件中声明,都可以轻松地将文档添加到任何方法,属性等中!
请参阅下面的示例:
/**
* Request calendar access.
* @param access granted block – the block to perform if access has been granted
*/
- (void) requestCalendarAccess:(void (^) (void)) accessGrantedBlock;
有关简单文档的更多信息,请点击此处: http://www.raywenderlich.com/66395/documenting-in-xcode-with-headerdoc-tutorial