编程规范

Posted leeanna

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了编程规范相关的知识,希望对你有一定的参考价值。

    关于编程规范,以c++为例来说明我个人在写代码时的一些习惯,包括文件的命名,在代码内部变量的命名等。

文件命名以及保存

  文件命名我会以时间来进行命名。这样有助于将各个不同文件保存,以免出现顺序乱了或冲突等现象(个人习惯)。保存时候会专门开一个相关文件夹,例如c++课成的代码是单独文件夹,java课成的又是另一个文件夹,这样提交与上传,后续复习时都比较方便。

代码内部相关

打代码时所用字体

   在使用devc++编程时候所使用的字体为它自带的字体,便于区分‘0’与‘O’,前者是阿拉伯数字0,后者是英文字母O。

打代码时的命名选择

   在命名函数时,往往会用所用算法的英文名来命名。例如求一个完数,将会命名该函数为“perfect number”,而在命名变量时,一般变量常用a,b,c等字母,按照字母表顺序运用,求和会命名为sum,求某个数会用num,求最大值用max,最小值命名为min,大部分采取英文或英文缩写的方式。在循环语句中习惯性是for语句中会用i来循环,输入多少个数习惯用n来表示等等。

打代码时代码段

   在打一段函数代码时,两个子函数之间习惯性会隔开一行,这样子看起来会比较清爽,显得代码没有这么冗杂,也便于后续修改。而且在输入注释时,习惯性在函数名的一行输入。输入函数名后,后续代码向下一行并且要缩进一段距离。例如:

   for(int i=0;i<n;i++)

       sum=0;

       sum+=i;

 

或者是:

  for(int i=0;i<n;i++)

 

 

       sum=0;

 

       sum+=i;

 

 

如果想到其他的后续会继续补充。

 

以上是关于编程规范的主要内容,如果未能解决你的问题,请参考以下文章

前端编程规范

编程规范之书写规范

《自拍教程》Python编程风格规范

良好的编程规范

Python 编程规范指南详解 上

Java基础--Java编程规范