二级标题语法基础
- 1.1 命名规范
- 1.2 注释规范
-
- 1.2.1 文件注释
-
- 1.2.2 文档注释
-
- 1.2.3 代码注释
-
- 1.2.4 使用TODO注释
- 1.3 导入规范
- 1.4 代码排版
1.1 命名规范
学习一点约定俗成的东西,练习的时候会慢慢养成
包名:用小写字母,不要用下划线。如com.apple.qucktime.v2
模块名:小写字母
类名:大驼峰命名。如SplitViewController
异常名:用Error作为后缀,如FileNotFoundError
变量名:小写字母,不过像I,l,O(i大写,L小写,o大写)就避免使用
函数名 :跟变量
常量名:大写字母
1.2 注释规范
1.2.1 文件注释
在开关加多行注释,,告诉文件的相关信息
1.2.2 文档注释
用三重双引号把注释括起来,从而可以被python的pydoc工具提取,有点像官方注释,既然是官方的,格式也要有官方范,如
"""
这是官方注释
这是官方注释
这是官方注释
"""
1.2.3 代码注释
给代码注释,这个简单
# 打印hello world
print('hello world')
1.2.4 使用TODO注释
通常在未完成的代码那里注释TODO,利用pycharm就可以直接跳到注释处,继续编写
1.3 导入规范
import
from … import …
1.4 代码排版
这个有Pycharm就不需要再操心了,选中需要排版的代码,按一下CTRL+ALT+L,或者在菜单栏选Code,再选Reformat Code,完事
重点在缩进:4个空格或按一次TAB
还有代码太长怎么办?在逗号后面换行;在运算符前面换行;续行符 ”\“ 换行,能不用则不用
本文转自SDK社区:http://www.sdk.cn
www.juhe.cn