把你的注释包含在 /*! 你的注释 */块里。
它是唯一一个能被 HeaderDoc 识别的格式
下面我给出了最重要的second level标签 , 但是注意了这并不是全部 . 我们稍后会看到一些 top level标签 . 我这里列出来的是最常用到的:
- @brief: 使用它来写一段你正在文档化的method, property , class , file , struct , 或enum的短描述信息.
- @discussion: 用它来写一段详尽的描述 . 如果需要你可以添加换行 .
- @param: 通过它你可以描述一个 method 或 function的参数信息 . 你可以使用多个这种标签.
- @return: 用它来制定一个 method 或 function的返回值.
- @see: 用它来指明其他相关的 method 或 function . 你可以使用多个这种标签.
- @sa: 同前一条类似.
- @code: 使用这个标签 , 你可以在文档当中嵌入代码段 . 当在Help Inspector当中查看文档时 , 代码通过在一个特别的盒子中用一种不同的字体来展示 . 始终记住在写的代码结尾处使用@endcode标签.
- @remark:在写文档时，用它来强调任何关于代码的特殊之处.
/*!
* @brief MD5加密字符串
*
* @discussion 传入一个字符串对象 并通过MD5加密算法对其进行 16位加密
*
* @param fromString为要加密的字符串对象
*
* @return 16位小写加密字符串
*/
- (NSString *)stringToMD5:(NSString *)fromString;
#pragma mark - MD5加密字符串
- (NSString *)stringToMD5:(NSString *)fromString{}