我使用的编程规范

2018-03-23  本文已影响23人  redexpress

我在使用的C、Objective-C、C++编编程时,有一套自己的规范,本文是我规范的基本内容,有些规范,比如空格两边要有空格,不是很基本就不列出。

规范1:变量和函数采用小些字母开头的匈牙利命名法【Java】

说明,方括号(【】)里面内容表示该规范从别的语言或平台中引入,下同。

规范2:使用2个或4个空格缩进

我主要使用4个空格缩进,在写一小段程序的时候,有时也适用2个空格缩进。

规范3:大括号放在行末,不另起一行【Java】

规范4:if、while、for语句体即使只有一行也应当用花括号括住【C#】

此规范还有两条附属规范。

规范4.1:特别短的语句可以例外,但需要符合规范4.2【Android】

规范4.2:特别短的语句如果不使用花括号括住,需要和条件部分放在同一行【Android】

示例:

// 【规范】
void printAge(double age) {
    if (age < 0) {
        return;
    }
    myPrint(age);
}
// 【规范】
void printAge(double age) {
    if (age < 0) return;
    myPrint(age);
}
// 【不好】
void printAge(double age) {
    if (age < 0)
        return;
    myPrint(age);
}

规范5:在使用指针时星号需按以下写法【Objective-C】

// 【规范】
int *p = &i;
// 【不好】
int* p = &i;
// 【不好】
int * p = &i;

规范5.1:指针符号后面先接const,再接标识符的,按以下写法

NSString * const NAME = @"Yang Gaofeng";

规范6:Golden Path

示例:

// 【规范】
void someMethod() {
    if (!someOther) {
        return;
    }
    // 重要的业务
}

// 【不好】
void someMethod() {
    if (someOther) {
        // 重要的业务
    }
}

此规范出自raywenderlich.com Objective-C style guide

规范7:文件的编码使用UTF-8

上一篇 下一篇

猜你喜欢

热点阅读