一 命名规范
尽量不要采用缩写;采用美国英语;即清晰又简短。
常用命名方法:
- 匈牙利命名,一般只是命名变量,原则是:变量名=类型前缀+描述,如bFoo表示布尔类型变量,pFoo表示指针类型变量。匈牙利命名还是有一定争议的,在OC编码规范中基本不被采用。
- 驼峰命名(Camel-Case),又称“骆驼命名法”,是指混合使用大小写字母来命名。驼峰命名又分为小驼峰法和大驼峰法。小驼峰法就是第一个单词是全部小写,后面的单词首字母大写,如myRoomCount;大驼峰法是第一个单词的首字母也大写,如ClassRoom。
- 文件名采用大驼峰法,如BlockOperation.h。
- 类别如果定义在一个独立的文件中,用“原始类名+类别名”作为类别文件名,如NSOperation+Operations.h
- 类、类别和协议等类型的命名应该采用大驼峰法,如SplitViewController
- 变量和属性采用小驼峰法,如studentNumber
- 常量采用k+大驼峰法,如kMaxStudentNumber
- 枚举成员采用大驼峰法,如ExecutionFailed
- 方法名应该是一个动词或动词短语,如果参数很多方法名读起来就像句子。
- 方法名采用小驼峰法。每个参数也应该采用小驼峰法。
文件注释:文件注释就是在每一个文件(头文件和实现文件)开头添加注释。文件注释通常包括如下信息:版权信息、文件名、所在模块、作者信息、历史版本信息、文件内容和作用等。
/*
GameViewController.h
Copyright (C) 2015 Eorient Inc. All Rights Reserved.
See LICENSE.txt for this sample's licensing infomation
Description:
This file contains the foundational subclass of NSOperation.
History:
15/7/22: Created by Tony Guan.
15/8/20: Add soket library
15/8/22: Add math library
*/
- ///,appledoc不支持,doxygen支持。
- /**…*/,都支持。
- /*! …*/,appiedoc不支持,doxygen支持。
代码注释:程序代码中处理文档注释还需要在一些关键的地方添加代码注释,文档注释一般是给一些看不到源代码的人看的帮助文档,而代码注释是给阅读源代码的人参考的。
- 单行注释(//)
- 多行注释(/*....*/)