首页 > 代码库 > 编程规范
编程规范
以前由于缺少一个统一放经验的地方,又因为所有的编程语言都是自学的,老师也教过,但是比较水,所以尽管我编程快四年了,但是仍然没有形成自己的风格。现在,我统一一下自己的编程风格。以M语言为基础,对C或JAVA语言也同样适用,若M语言与其他语言编程上有不同,我会分开说明。
下面我将从以下几个方面规范我的编程:
一 M语言
1 M文件的命名规范(function命名规范)
(1)M文件命名以小写字母开头命名。传统的m文件都是以小写字母开头,如 disp、random、randperm,就如所有的关键字一样都是以小写字母出现的。
(2)M文件命名最好以动词开头。
若在M文件中除了与m文件相同命名的function外,若还有其他function,那么它的命名规则与上面相同。
注明:若用两个单词叠加的名字,第二个单词起始字母大写。如calculateImpedance
2 注释规范
(1)function 注释规范
function功能函数注释包括
a. purpose (函数功能) :用英文解释函数功能
b.para(参数解释):用英文解释所有参数意思
c.return(返回值):用英文解释返回值的个数和意思,所有不同情况的返回值,可以参考matlab自带的m文件写。
d.date(编写日期):
f:modify(程序修改)
when(程序修改日期):
what(修改了什么):
why(为什么要修改):有了修改了什么,有的时候可以不用说为什么修改
(2)其他注释
对某一个变量的注释:
注释写在变量的后面,并且按某一条线对齐。
对一大段程序注释:
写在这段程序的开始。
(3)修改注释
小规模的修改,写在修改注释中就行了,否则要写入function 的 modify中。
小规模修改中,只有对程序的结果产生比较大的影响才写修改注释。
修改注释规范:
when who what why source(源程序)
比如 2015-1-30 jcx 因为。。修改了。。。soruce(源程序):
如果source(源程序)比较大,那么可以使用%注释掉放在修改的程序下面。
4 变量命名规范
常量(constant):字母全大写
单变量:第一个单词都小写,后面的单词起始字母大写。
数组:加后缀Arr
结构体:加后缀Stru
二 C语言
编程规范