ios 对方法的注释规范

一些小东西在此记录一下，以后会断断续续的记录下来其他的小知识，有时间可以翻来看看。1------关于ios注释规范

/**
 * @brief 带字符串参数的方法.
 *
 * @param  valueOne 值.
 * @param  valueTwo 值.
 * @return 返回value.
 *
 * @exception NSException 可能抛出的异常.
 *
 * @see someMethod
 * @see someMethodByInt:
 * @warning 警告: appledoc中显示为蓝色背景, Doxygen中显示为红色竖条.
 * @bug 缺陷: appledoc中显示为黄色背景, Doxygen中显示为绿色竖条.
 */

时间： 2024-10-03 21:53:32

ios 对方法的注释规范的相关文章

iOS开发- Xcode插件(一)-规范注释生成器VVDocumenter

分享几个常用的Xcode插件. 第一个, 规范注释生成器VVDocumenter. 顾名思义, 它可以很方便的为你自动添加注释使用效果如下: 下载链接:https://github.com/onevcat/VVDocumenter-Xcode 使用说明: 1.前往GitHub下载工程文件:VVDocumenter-Xcode 2.用Xcode打开工程,Command + B Build成功后,可以在~/Library/Application Support/Developer/Shared/X

iOS端项目注释规范附统一代码块

代码的注释经常被人忽略,以至于在后期维护的时候较为困难.我们准备在XX项目开始之前制定一套规范的注释体系,致力于达到就算维护人员改变也能快速上手的效果. 1.属性注释属性注释使用 /** 注释*/ 的文档注释格式. 这种注释相较于// 注释的优点是此属性可以在后面的引用时,在智能提示的下方显示中文注释如果你不是在董铂然博客园看到本文请点击查看原文. 例如: /** 回复率*/ @property(nonatomic,strong)MTPoiCompareM *replyRate; /**

php类的方法注释规范

一个好的注释有非常大的作用,符合规范的注释,在调用时,编辑器会直接显示注释信息,这样能增加团队协作的速度和能力.注释规范如下. /** * 方法描述 * @access private * @author AT路遥 * @version 1.0 * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @param mixed $mixed 这是一个混合类型 * @return array or null */ 效果: 原文地址:http

《从零开始学Swift》学习笔记（Day 57）——Swift编码规范之注释规范：

<从零开始学Swift>学习笔记(Day 57)--Swift编码规范之注释规范:文件注释.文档注释.代码注释.使用地标注释原创文章,欢迎转载.转载请注明:关东升的博客前面说到Swift注释的语法有两种:单行注释(//)和多行注释(/*...*/).这里来介绍一下他们的使用规范. 文件注释文件注释就在每一个文件开头添加注释,文件注释通常包括如下信息:版权信息.文件名.所在模块.作者信息.历史版本信息.文件内容和作用等. 下面看一个文件注释的示例: /* Copyright (C) 201

java注释规范

前言: 现在java的出产地sun公司并没有定义一个java注释规范,注释规范目前是每个公司自己有自己的一套规范,主要是为了团队之间的协作. 1.基本规则 1.注释应该使代码更加清晰易懂 2.注释要简洁明了,只要提供能够明确理解程序必要的信息就可以了.如果注释太复杂会影响程序整洁度和阅读感. 3.注释不仅描述程序作了什么,还要描述为什么这样做以及约束. 4.对于一般的getter和setter方法不用注释. 5.类.接口.构造函数.方法.全局变量必须添加注释.字段属性可以选择添加简单注释. 6.

PHPDocumentor代码注释规范说明

PHPDocumentor是一个的用PHP写的道具,对于有规则注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档. 标记用途描述 @abstract 抽象类的变量和方法 @access public, private or protected 文档的访问.使用权限. @access private 表明这个文档是被保护的. @author 张三 <[email protected]> 文档作者 @copyright 名称时间文档版权信息 @deprecate

PHPDocumentor 注释规范整理

你会写注释么?从我写代码开始,这个问题就一直困扰着我,相信也同样困扰着其他同学.以前的写注释总是没有一套行之有效的标准,给维护和协同开发带了许多麻烦,直到最近读到了phpdocumentor的注释标准. 下面对phpdocumentor的注释标准进行总结: Type(数据类型): string 字符串类型 integer or int 整型 boolean or bool 布尔类型 true or false float or double 浮点类型 object 对象 mixed 混合类型没

java 注释规范参照

1.注释形式统一在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2.注释内容准确简洁内容要简单.明了.含义准确,防止注释的多义性,错误的注释不但无益反而有害. 注释条件: 1.基本注释(必须加) (a) 类(接口)的注释 (b) 构造函数的注释 (c) 方法的注释 (d) 全局变量的注释 (e) 字段/属性的注释备注:简单的代码做简单注释,注释内容不大于10个字即可,

JAVA命名、注释规范

一.命名规范 1. 项目名全部小写 2. 包名全部小写(除非部分是缩写) 3. 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写. 如:public class MyFirstClass{} 4. 变量名.方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写.即:驼峰法则. 如:int index=0; public void toString(){} 5. 常量名全部大写如:public static final String GAME_COLOR=”RED”;