编程规范

本页目录

本节介绍几种编程规范，包括代码注释、代码续行和代码缩进等。

代码注释

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

【Excel VBA】

Excel VBA中使用单引号进行代码注释，可以整行注释，也可以在代码末尾进行注释。对于1.2.2小节的简单示例，在代码中添加注释，如下所示：

code.vba 
Function MySum(sngX As Single, sngY As Single) As Single
  '大谦Excel，dqexcel.com
  '计算两个实数的和
  MySum = sngX + sngY
End Function
Sub Test()
  Debug.Print MySum(1, 2)  '调用函数求1和2的和
  Debug.Print MySum(3, 5)  '调用函数求3和5的和
End Sub

【Python】

Python中使用符号#进行单行代码的注释，使用三引号进行多行代码的注释。在“Python 3.7.7 Shell”窗口中单击“File”菜单中的“New File”选项，打开脚本文件窗口，在其中输入下面的语句，实现两个数的相加运算。为了便于阅读，添加了必要的注释文本。

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

代码续行

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

【Excel VBA】

Excel VBA中在代码行断开的地方用下划线指定续行操作。下面的代码在当前工作表的第3行上面插入行，复制第2行的格式：

code.vba 
Rows(3).Insert Shift:=xlShiftDown,CopyOrigin=:xlFormatFromLeftOrAbove

现在如果觉得代码行太长了，希望将它分两行书写，可以改成下面的形式：

code.vba 
Rows(3).Insert Shift:=xlShiftDown, CopyOrigin:= _
                              xlFormatFromLeftOrAbove

注意续行符下划线前面有一个空格。

【Python】

Python中在代码行断开的地方用反斜杠指定续行操作。下面的代码在工作表sht的第3行上面插入行，复制第2行的格式：

code.python 
>>> sht.api.Rows(3).Insert(Shift=xw.constants.InsertShiftDirection.xlShiftDown,CopyOrigin=xw.constants.InsertFormatOrigin.xlFormatFromLeftOrAbove)

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

code.python 
>>> sht.api.Rows(3).Insert(\
	    Shift=xw.constants.InsertShiftDirection.xlShiftDown,\
	    CopyOrigin=xw.constants.InsertFormatOrigin.\
	    xlFormatFromLeftOrAbove)

代码缩进

代码缩进可以呈现编码的结构之美。在Python中更有明确的规定。

【Excel VBA】

Excel VBA中，对于语句行前面缩进多少并没有明确的规定，可以是两个空格，也可以是四个空格，可以自己确定。下面的过程中有一个判断结构，当某个条件满足时执行相应的代码，通过代码缩进，可以更清晰地知道什么条件执行什么代码，便于阅读。

code.vba 
Sub Test()
  Dim intSC As Integer
  intSC = InputBox("请输入一个数字：")
  If intSC >= 90 Then
    Debug.Print "优秀"
  ElseIf intSC >= 80 Then
    Debug.Print "良好"
  ElseIf intSC >= 70 Then
    Debug.Print "中等"
  ElseIf intSC >= 60 Then
    Debug.Print "及格"
  Else
    Debug.Print "不及格"
  End If
End Sub

【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("不及格")