编程规范

本页目录

下面介绍几种编程规范，包括代码注释、代码续行和代码缩进等。[大谦MATLAB，dqmatlab点com]

代码注释

为了便于自己或他人阅读和理解程序代码，常常需要在代码中添加注释。注释不参与代码的编译。

【MATLAB】

在MATLAB中，使用符号“%”进行代码的注释。在MATLAB“主页”功能区单击“新建脚本”按钮，新建一个脚本。MATLAB中将脚本文件称为M文件。将文件保存为“s01.m”。

code.matlab 
MySum(1,2)  %重复调用MySum函数
MySum(3,5)
MySum(8,12)
%定义MySum函数实现相加运算
function s=MySum(a,b)
  s=a+b;
end

代码中注释文本可以放在代码后面，也可以单独放在一行。

【Python】

在Python中，使用符号“#”进行单行代码的注释，使用三引号进行多行代码的注释。在Python Shell窗口中，选择File→New File命令，打开编写脚本文件的窗口，并输入下面的语句，实现两个数的相加运算。为了便于阅读，添加了必要的注释。将代码保存到s01.py。

code.python 
#定义MySum函数实现相加运算
def MySum(a,b):
    return a+b
'''
使用函数的好处是可以将特定功能做成函数
在必要时可以重复调用该函数
从而提高编程效率，并且减少代码量
'''
print(MySum(1,2))  #重复调用MySum函数
print(MySum(3,5))
print(MySum(8,12))

代码续行

在编写代码的过程中，有时会出现代码行太长，需要断开分为多行编写的情况。此时需要用特定符号指定续行操作。

【MATLAB】

MATLAB中用英文半角状态下的省略号(...)指定续行。下面的代码将D盘下的Excel文件“身份证号.xlsx”第2个工作表中的数据读取到表T，将工作表中的第1行作为索引行，将第1列作为索引列。

code.matlab 
>> T=readtable('D:\身份证号.xlsx','VariableNamingRule','preserve','ReadRowNames',true,'Sheet',2)

代码比较长，改写成2行。

code.matlab 
>> T=readtable('D:\身份证号.xlsx','VariableNamingRule','preserve',...
'ReadRowNames',true,'Sheet',2)

在第1行代码最后添加续行符号。

【Python】

在Python中，代码行断开的地方用反斜杠指定续行操作。下面的代码将D盘下的Excel文件“身份证号.xlsx”第1和第2个工作表中的数据读取到DataFrame df，“工号”列为索引列，引擎为OpenPyXL：

code.python 
>>> df=pd.read_excel(io='D:\身份证号.xlsx',sheet_name=[0,1],index_col='工号',engine='openpyxl')

代码行太长，可以改写成下面的形式。

code.python 
>>> df=pd.read_excel(io='D:\身份证号.xlsx',sheet_name=[0,1],\
index_col='工号',engine='openpyxl')

在第1行代码最后添加续行符号。

代码缩进

代码缩进可以呈现编码的结构之美，主要用在函数、结构语句等处。在Python中有关于代码缩进的明确的规定。

【MATLAB】

MATLAB对代码缩进没有严格要求，或者说，代码缩进格式不统一时不会影响代码的运行。但是，统一代码缩进格式会使代码更美观，更便于阅读。

【Python】

在Python中，代码的结构层次是通过缩进来实现的，建议统一缩进4个空格，不要使用制表符进行缩进。

在下面的函数中，第2行开始的函数体相对于第1行缩进了4个空格。

code.python 
def MySum(a,b):
   return a+b

在下面的判断结构中，每个条件判断语句行下面要执行的代码行缩进4个空格。

code.python 
sc= int(input('请输入一个数字：'))
if(sc>=90):
   print('优秀')
elif(sc>=80):
   print('良好')
elif(sc>=70):
   print('中等')
elif(sc>=60):
   print('及格')
else:
   print('不及格')