计算机怎样编程与计算思维 (30).pdf

信息技术基础：

计算机、怎样编程与计算思维（Python版）

必须：

建议：

不建议：

实用编程规约

编程规约

编程好比写文章，规范书写很重要！

编程规约的含义是指一项软件工程中命名标准、代码风格、文

档书写等要保持规范、一致，方便阅读修改和交流。

本讲列出我学习实践中总结的一些常用编程规范

文中某些建议是个人观点

2

命名法的基本原则

驼峰命名法：如变量名是numStudents，中间的单词Student首字

母大写(类比驼峰)，便于阅读

下划线分隔法：如变量名是num_students，中间的单词用下划线

分隔，便于阅读

一般来说，一项软件工程里只采用一种命名方式

3

命名法的基本原则

“最小长度,最大信息量”的原则

例如，将numStudents改为numStuds，Stud为缩写，即能看出含

义，长度又短；例如，存储矩阵A的行数的变量：nRowsA

单词缩写规律：前3-4个字母，如absolutevalue缩写为abs；前3-4个辅音

字母，如square缩写为sqr；squareroot缩写为sqrt

不推荐使用数字标记，如a1，aa含义不清！

有时，宁可命名长，也不要丧失含义的易读性(参考：Java语言里

InputStreamReader类的命名)

4

命名法的基本原则

变量名

因表示物体、概念，采用名词或形容词+名词的形式，例如，

familyName或familiy_name

函数、方法

因表示操作，常采用动词或动词+名词的形式，例如，printRecords()或

()

类名首字母大写，与普通变量名区分

例如，Person

矩阵也用常用大写字母

例如，机器学习中的特征矩阵X，而向量习惯用小写字母，例如，标签

向量y

5

命名法中的“不建议”

循环控制变量习惯上用i,j,k,m,n等

其它变量尽量不使用单个字母(如a,b,x,y)命名

与公式不同，程序中的变量多，不清晰命名容易搞混

不建议使用匈牙利命名法(变量名里含有属性、类型、对象描述)，因

其书写形式过于复杂

但是可以借鉴一点，比如strFamily

不建议用汉字命名，因为无法国际化

不建议使用汉语拼音命名，建议用英文单词

区分单复数

比如，列表scores表示列表里存储多个分数

6

表示常量的变量

Python中没有符号常量，建议把表示“常量”的变量(比如，学生

人数num_studs=100)在程序开头定义

非常不建议把常量值直接写在程序中，修改时易漏掉

把所有“常量”在程序开头定义，程序中使用；若需更改该值，只需要在开

头处修改一次

“常量”前加个注释：#本程序所用常量，提醒编程者在程序中不要修改该

值

7