ios 对方法的注释规范

Posted old_k

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了ios 对方法的注释规范相关的知识,希望对你有一定的参考价值。

一些小东西在此记录一下,以后会断断续续的记录下来其他的小知识,有时间可以翻来看看。
1------关于ios注释规范
/**
 * @brief 带字符串参数的方法.
 *
 * @param  valueOne 值.
 * @param  valueTwo 值.
 * @return 返回value.
 *
 * @exception NSException 可能抛出的异常.
 *
 * @see someMethod
 * @see someMethodByInt:
 * @warning 警告: appledoc中显示为蓝色背景, Doxygen中显示为红色竖条.
 * @bug 缺陷: appledoc中显示为黄色背景, Doxygen中显示为绿色竖条.
 */

  

以上是关于ios 对方法的注释规范的主要内容,如果未能解决你的问题,请参考以下文章

JAVA编程规范-注释规范

3.7 代码注释和编码规范

python注释及命名规范

Pyhton 单行多行注释符号使用方法及规范

自己总结的C#编码规范--4.注释篇

php类的方法注释规范