代码注释规范

代码注释规范Tag内容描述：<p>1、IOS开发编码及命名规范目录1、目的32、适用范围33、编码规范33.1、文件33.2、注释33.3、编码排版格式53.4、命名规范63.4.1、保留字63.4.2、方法73.4.3、变量73.4.4、常量83.4.5、类93.4.6图片命名93.5、修改规范93.5.2、新增代码行93.5.2、删除代码行103.5.3、修改代码行103.5.4、其他规范101、目的统一规范XCode编辑环境下Objective-C的编码风格和标准2、适用范围适用于所有用Objective-C语言开发的项目。3、编码规范3.1、文件1) 项目文件必须使用一个有意义的名字一般用bundleId最后一位如lender。</p><p>2、Comments criterion of the Code 在多个PROJIECT共同开发的前提下，为了减少修改升级CODE过程中出现失误和方便SI人员对代码的维护，加强部门整体代码注释规范，建议通过在每一次代码修改过程中添加代码标志符进行注释，这样可以使软件工程师在升级代码的过程中减少错误率，同时可以保持对以前版本代码的修改思路清晰，能在最短时间里复查代码中的错误。标准C+/C的文件结构：/ Copyright (c) Microsoft Corporation. All rights reserved./ Use of this source code is subject to the terms of the Microsoft end-user/ license agreement。</p><p>3、程序代码注释编写规范为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。一般情况下，源程序有效注释量必须在20以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。常规注释有以下两种方式。单行:以/符号开始，任何位于该符号之后的本行文字都视为注释。多行:以/*符号开始，以*/结束。任何介于这对符号之间的文字都视为注释。一、 说明性文件说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释。</p><p>4、网页制作过程中代码注释书写规范点评：总结了一下自己工作中使用到的注释书写规范，没有什么技术含量，只是用于统一制作方式，方便维护。包含了“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。 大部分同学使用的区域注释的方法，会以“注释总结了一下自己工作中使用到的注释书写规范，没有什么技术含量，只是用于统一制作方式，方便维护。包含了“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。 大部分同学使用的区域注释的方法，会以“注释内容开始”或“注释内容结束”、“start”或“end”等，相。</p><p>5、程序注释规范说明程序注释规范应包括以下三方面：一、文件头部注释在代码文件的头部进行注释，这样做的好处在于，我们能对代码文件做变更跟踪。在代码头部分标注出创始人、创始时间、修改人、修改时间、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少个程序员的开发和修改。样本：/* 作者： Liuchao* 创始时间：2007-11-12* 修改人：Liuchao* 修改时间：2007-11-12* 修改人：Liaochao* 修改时间：2007-11-12* 描述。</p>