书接上回~
今天我们继续来说说
注释
1、注释
1.1、块注释
“#”号后空一格,段落件用空行分开(同样需要“#”号)
1.2、行注释
至少使用两个空格和语句分开,注意不要使用无意义的注释
1.3、建议
- 在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释
- 比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性
2、文档注释(Docstring)
作为文档的Docstring一般出现在模块头部、函数和类的头部,这样在python中可以通过对象的doc对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.
- 文档注释以 “”" 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例