无论你用什么语言编写代码,无论你要开发多么简单的项目,无论你要实现多么明显的功能,好习惯就让我们从点滴开始吧:
如果说写代码的语法是法律的话,那么代码的规范化应该是道德了吧,一个仅仅遵守法律而几乎没什么道德的人,相信大家都不会喜欢的,所以从今天开始,从现在开始,从我们手下的每一个小程序开始,让我们做一个有着很好道德的人吧。
一,注释
注释就好比一个翻译官,又好比一个导游,把某一段代码要实现的功能,某个方法的作用,某个变量用来存储的内容……都解释的相当详细,可维护性好的项目离不开好的注释。
如果说写代码的语法是法律的话,那么代码的规范化应该是道德了吧,一个仅仅遵守法律而几乎没什么道德的人,相信大家都不会喜欢的,所以从今天开始,从现在开始,从我们手下的每一个小程序开始,让我们做一个有着很好道德的人吧。
一,注释
注释就好比一个翻译官,又好比一个导游,把某一段代码要实现的功能,某个方法的作用,某个变量用来存储的内容……都解释的相当详细,可维护性好的项目离不开好的注释。
二,命名规范
1、介绍两种C#中的命名规范:
a、骆驼命名法(骆驼命名法)→第一个单词首字母小写,之后的单词首字母大写(userName、userPassword、realName……)
这类命名法通常用来给普通变量、字段命名。
b、帕斯卡命名法→每一个单词的首字母都大写,其余的字母小写(GetName()、GetMax()、ChangeName()……)
这类命名法通常用来给方法、类命名。
2、见名知其意:
a、定义的变量、方法、类、字段……名字要有意义,要做到见其名知其意得效果。(杜绝简单用i、j、a、b……来命名)
b、动名词的使用:像方法(执行动作的)应该用一个动词命名(GetName());像用户名这一变量,适合用名词命名(userName)
三,格式规范
在编程中,好多软件在代码执行时都不对格式做要求,只要语句对就完全可以执行过去,但是,要知道代码写出来不仅仅是给计算机执行的,当代码出现问题后程序员要进行差错,公司里面还要跟别人沟通,后期还要对代码进行维护或者是修改,所以更多时候代码是要给人看的。打个比方:如果一个房间里堆满的都是最豪华的家具,可以说样样俱全,但是摆放一点都不整齐、规律,所以当你需要某个东西的时候你想想当时会是什么感受。
所以为了培养我们的高道德,为了我们开发的软件、写出的程序具有很好的可读性、可维护性,让我们养成好的习惯就从代码的规范化开始吧!