C语言编程范式 —— 命名原则与排版

版权声明:来自追求极客技术的极客人(Hackyle)——相信技术成就梦想、实现自身价值! https://blog.csdn.net/ComputerGeekHack/article/details/88830917

【谁终将声震人间,必将长久深自缄默;谁终将点燃闪电,必将长久如云漂泊。 —— 尼采】

内容概述

  1. 命名原则:12条变量名命名原则,教你怎么命名;
  2. 命名强制性要求:C语言的语法规定,必须遵守;
  3. 命名方式:三种命名方法——峰坨式、匈牙利式;
  4. 我写代码的排版习惯:需求问题 --> 变量申明 --> 逻辑代码区(使用空行) --> 返回值(前至少空一行)

命名原则

1)命名应当直观且可以拼读,可望文知意,便于记忆和阅读。

标识符最好采用英文单词或其组合,不允许使用拼音。程序中的英文单词一般不要太复杂,用词应当准确。


2)命名的长度应当符合“min-length && max-information”原则。

C 是一种简洁的语言, 命名也应该是简洁的。例如变量名MaxVal 就比MaxValueUntilOverflow 好用。标识符的长度一般不要过长,较长的单词可通过去掉“元音”形成缩写。另外,英文词尽量不缩写,特别是非常用专业名词,如果有缩写,在同一系统中对同一单词必须使用相同的表示法,并且注明其意思。

3)当标识符由多个词组成时,每个词的第一个字母大写,其余全部小写。

int CurrentVal; //多个单词时首字母全部大写;
int value; //一个单词时就小写;

这样的名字看起来比较清晰,远比一长串字符好得多。

 

4)尽量避免名字中出现数字编号,如Value1,Value2 等,除非逻辑上的确需要编号。

比如驱动开发时为管脚命名,非编号名字反而不好。初学者总是喜欢用带编号的变量名或函数名,这样子看上去很简单方便,但其实是一颗颗定时炸弹。这个习惯初学者一定要改过来。

5)对在多个文件之间共同使用的全局变量或函数要加范围限定符(建议使用模块名(缩写)作为范围限定符)

如(GUI_ etc_)标识符的命名规则;

6)标识符名分为两部分:规范标识符前缀(后缀) + 含义标识。非全局变量可以不用使用范围限定符前缀。

①  数据类型前缀命名规则。

含义标识命名规则,变量命名使用名词性词组,函数命名使用动词性词组。

变量含义标识符构成:目标词+ 动词(的过去分词)+ [状语] + [目的地];

函数含义标识符构成:动词(一般现时)+目标词+[状语]+[目的地];

 

7)程序中不得出现仅靠大小写区分的相似的标识符。

int x, X; //变量x 与X 容易混淆

void foo(int x); //函数foo 与FOO 容易混淆
void FOO(float x);

这里还有一个要特别注意的就是1(数字1)和l(小写字母l)之间,0(数字0)和o(小写字母o)之间的区别。这两对真是很难区分的,我曾经的一个同事就被这个问题折腾了一次。

8)一个函数名禁止被用于其它之处。

#include "c_standards.h"
void foo(int p_1)
{
   int x = p_1;
}
void static_p(void)
{
   int foo = 1u; //用函数名作为变量名,不可取
}

9)所有宏定义、枚举常数、只读变量全用大写字母命名,用下划线分割单词。

#define PI 3。1415926 //宏定义
const int MAX_LENGTH = 100; //这不是常量,而是一个只读变量
#define FILE_PATH “/usr/tmp” //宏替换(宏定义)

10)考虑到习惯性问题,局部变量中可采用通用的命名方式,仅限于nij 等作为循环变量使用。

//一定不要写出如下这样的代码:
   int p;
   char i;
   int c;
   char * a;

一般来说习惯上用n,m,i,j,k 等表示int 类型的变量;cch 等表示字符类型变量;a 等表示数组;p 等表示指针。当然这仅仅是一般习惯,除了i,j,k 等可以用来表示循环变量外,别的字符变量名尽量不要使用。

11)定义变量的同时千万千万别忘了初始化。定义变量时编译器并不一定清空了这块内存,它的值可能是无效的数据。
12)不同类型数据之间的运算要注意精度扩展问题,一般低精度数据将向高精度数据扩展。

 


命名强制性要求

1. 只能以字母或下划线开始;

2. 不能以数字开始;

3. 关键字不允许用(eg: int float=2;错误, float 为保留字不允许用);

 


命名方式

1、小驼峰法

变量一般用小驼峰法标识。驼峰法的意思是:除第一个单词之外,其他单词首字母大写。

//形如以下的方式命名
int myStudentCount;//变量myStudentCount第一个单词是全部小写,后面的单词首字母大写。

2、大驼峰法(帕斯卡命名法)

//形如以下的方式命名
int DataValue; //每个单词的首字母都大写

3、匈牙利命名法:

基本原则是:变量名=属性+类型+对象描述。

int 全局变量标识符_数据类型标识符+真正的变量名;
int g_iMyData=10; //g代表全局变量,i代表是int型,MyData是变量名

char cMyValue; //c代表着是char类型,后面的采用大驼峰法命名

具体的细节请参考以上的第6条命名原则。


我写代码的排版习惯

猜你喜欢

转载自blog.csdn.net/ComputerGeekHack/article/details/88830917