本人所学的代码规范

目录

前言

1、魔法数字的定义

2、魔法数字的使用

3、匈牙利命名法

4、自己的命名办法

5、吐槽

 6、大小写的规范使用

 7、多写些功能模块

 8、注释

---

前言

记录一下本人所学到的代码规范，更加详细的内容可以去看书《code complete 2》，也不多，几百页罢了。

1、魔法数字的定义

首先提个概念→magic number魔法数字。

在源代码编写中，有这么一种情况：编码者在写源代码的时候，使用了一个数字，比如0x2123，0.021f等，他当时是明白这个数字的意思的，但是别的程序员看他的代码，可能很难理解，甚至，过了一段时间，代码的作者自己再看代码的时候也忘记了这个数字代表的含义。于是感叹，虽然不知道这个数字是干什么用的，究竟代表什么，但是编译后的程序可以正常运行，真是“魔术般的数字”。

2、魔法数字的使用

我们平时也是会经常在无意中使用“魔法数字”，例如
定义变量是：int x =2。
写循环：for i in list。
这里面用到的x、i、list都是教科书上默认出现的，然后在自己写代码的时候也是默认用这些字来写。在你写的时候，相信你能看懂，多写几个类似的函数或者是过几个月再看的时候就觉得很乱，就看不懂了。

3、匈牙利命名法

所以命名要一眼就能看懂这个是干啥的，有一个推荐的命名办法：匈牙利命名法：
其基本原则是：变量名=属性+类型+对象描述，其中每一对象的名称都要求有明确含义，可以取对象名字全称或名字的一部分。要基于容易记忆容易理解的原则。保证名字的连贯性是非常重要的。

4、自己的命名办法

你要是看不懂上面（第3）写了啥，你就写一串长的英文描述，然后取开头字母。或者是写很短的英文单词来命名。

5、吐槽

尽量别使用拼音和片假名。

 6、大小写的规范使用

C语言和Java都是小写字母写的，数据库命令都是大写字母。通过“大小写”可以快速区分数据库命令和编程语言。

例如：C语言写hello，World。

#include<stdio.h>
int main()
{
    printf("Hello,World");
    return 0;
}

数据库创建表的命令。

 7、多写些功能模块

每个功能模块要尽量的小，功能单一，这样才能提高重复使用率。单个模块写的太多，下次要用还要更改很多东西，就不适合重复使用。

 8、注释

代码注释不必每一句代码都写，写个核心的内容注释就好了，能你过几个月或者是别人快速看懂就行。