objective c的注释规范

时间:2021-08-25 23:43:01

以前写android程序,每写一个函数或者类就添加对应的注释,后来领导让生成api文档,直接使用了eclipse的到处文档功能,强大又方便,这次换作ios开发,我想肯定也有对应的注释,于是上网查找了一番,抄录如下:

对于单行和多行注释大家都再熟悉不过了,下面主要写一下指令,也就是在编写程序时按住alt键或者command键能够显示出来的注释

 @brief : 简要注释. appledoc中仅对属性、方法有效,对类、协议 无效,会造成后续内容解析失败.
@param : 参数描述.
@return : 返回值描述.
@exception : 异常描述.
@see : 参见.
@sa : 参见. 同@see.
@warning : 警告.
@bug : 警告.
@name : 组名. 用于给成员们分组, 既文档中Tasks区的子类别.

示例代码如下:

 @interface medexParseXML : NSObject
/**
@brief 传入xml文件名称和根节点的下一级节点的名称得到该节点的xml字符串
@param xmlName xml文件名称
@param nodeName 根节点下一级节点名称
@return 返回节点对应的xml字符串
*/
-(NSString*) getFileNodeXML:(NSString*)xmlName :(NSString*)nodeName; /**
@brief 传入xml字符串获得下一级节点的xml字符串
@param xmlStr xml格式的字符串
@param nodeName xml字符串下一级节点名称
@return 返回节点对应的xml字符串
*/
-(NSString*)getStrNodeXML:(NSString*)xmlStr :(NSString*)nodeName; /**
@brief 传入xml字符串获得该字符串包含的下一级节点的值
@param xmlStr xml格式的字符串
@param nodeName 下一级要获取值的节点的名称
@return 返回节点的值
*/
-(NSString*)getStrNodeXMLValue:(NSString*)xmlStr :(NSString*)nodeName; /**
@brief 传入xml字符串获得对应的属性的值
@param xmlStr xml格式的字符串
@param AttributeName 要获取的属性的名称
@return 返回与属性对应的值
*/
-(NSString*)getXMLAttribute:(NSString*)xmlStr :(NSString*)AttributeName;
@end

然后在编写代码时对某一个方法不清楚可以按下alt键弹出提示,如图:

objective c的注释规范