假设你来到了一家新的互联网公司,这个公司内部没有明确的代码规范,代码的编写,函数、参数甚至是类的命名都没有明确的规定,每个员工在进行工作时编写的代码虽然不至于完全没有注释,但注释的方法千姿百态,更别说还有很多碎碎念似的注释,意义不明,但又不得不看,因为你不知道里面那一句就是重要的。代码的格式也是参差不齐,好似一嘴蓝牙横七竖八。
现在你的主管告诉你,我们的程序有了些小问题,雇你来就是让你解决这些问题的,你之前负责这块的员工已经跑路了。
请大声的告诉我您心中的真实想法 !
代码规范的唯一目的就是为了提升可读性,我们都知道一个软件项目的生命周期中至少有60%是在对软件项目进行维护,而进行软件维护的第一件事就是能读懂维护的软件的代码。因此代码规范的意义往小了说是方便我们程序员进行维护和修改,另一方面更是减少了公司的成本。
代码规范都有哪些?1.注释
(1)单行注释 " // "
(2)多行注释 "/* 。。。。。。。 */ "
(3)代码块注释 " /// " 用来注释代码块的用途,参数和返回值。
(1)帕斯卡(Pascal)命名法
用法:每个单词的首字母均大写
何时使用?
在对类名,方法名,属性进行命名时使用Pascal命名法
类名:
public partial class StudentLoginForm : Form
{
}
方法名:
public List <OnLineInfo> GetList()
{
IOnLine onLine = onLineFactory.CreateOnline();
List<OnlineInfo> list = onLine.GetList();
if (list.Count == 0)
{
throw new Exception("此时没有学生上机");
}
else
{
return list;
}
}
属性名:
public string CardType
{
get
{
return _cardType;
}
set
{
_cardTyoe = value;
}
}
(2)驼峰(Camel)命名法
用法:除首个单词首字母不大写,其余单词首字母大写。
何时使用:在对变量,字段,参数进行命名时使用 Camel 命名法。
变量 :
FormClosing formClosing = new FormClosing();
字段 :
private string cardType;
参数 :
public void txtNumber_KeyPress(object sender, KeyPressEventArgs e)
{
//IsDigit 判断的是十进制数字,就是 '0 '..'9 '。
if (e.KeyChar != '\b' && !Char.IsDigit(e.KeyChar))//\b是退格键
{
e.Handled = true;
MessageBox.Show("请输入数字", "温馨提示", MessageBoxButtons.OK, MessageBoxIcon.Information);
return;
}
}
(3)常量的命名:
常量在进行命名时要求所有字母都大写,单词之间通过 " _ " 进行分隔。
如:
LOGIN_NAME
3.括号规则
(1)大括号规则
public abstract class Login
{
代码块内容
}
(2)小括号规则
不要让小括号和里面的内容紧贴在一起,留出一定的位置。
(1)库名: 数据库命名规则采取首字母大写。
(2)表名:使用T_表名 ,表名的首字母大写,如果有多个子系统模块则将模块的缩写加在T后,用下划线与表名分割。
(3)字段名:第一个单词字母小写,后面的单词采用第一个字母大写。
(1)源码打包初版时,版本号为1.00;
(2)当源码包被局部修改或bug修正时,发行号不变,修改号第二个数字增1。例如,对初版源码包作了第一次修订,则版本号为 V1.01;
(3)当源码包在原有的基础上增加部分功能,发行号不变,修改号第一个数字增1,例如,对V1.12版的基础上增加部分功能,则新版本号为 V1.20。
(4)当源码包有重要修改或局部修订累积较多导致源码包发生全局变化时,发行号增1。例如,在 V1.15 版的基础上作了一次全面修改,则新版本号为 V2.00。