开头注释除了必要的信息外,一些简单的介绍也是尤为重要呢,比如作者、创建日期、更新日期、里面代码大体是实现什么功能的简要介绍。这些介绍不但是规范,更是一种认真工作态度的体现。
下面给大家展示一下我的开头注释是怎么写的。
#!/user/bin/env python
# -*- coding:utf-8 -*-
# 作者:小蓝枣
# 创建:2019-03-01
# 更新:2019-03-15
# 用意:用于剪切板内容编辑
#!user/bin/env python
这行代码在 unix 类系统里才有用,linux 系统就属于 unix 类系统。
这是告诉系统要运行这个文件要用什么运行。
windows 系统是根据扩展名 .py 来关联的,所以只要是 .py 结尾,直接就会用 python 来运行;
以前还有这么写的,直接指明 python 的绝对位置:
#!user/bin/python
因为 python 有可能不在 bin 下面,env python 是直接找到 python 的安装位置,更实用。
# -*- coding:utf-8 -*-
python2 系列默认不支持中文,只有使用 utf-8 等支持中文的编码,才可以使用中文。
python3 系列默认就支持中文了,所以无论是什么编码也没问题了。
我觉得一段好代码,应该有更好的兼容性,我们写了这样的开头,直接就可以在 linux 下和 python2 下运行,这些还是很主流的,而且对我们的 windows 和 python3 一点影响也没有,多么两全其美!
一个好的程序员,当然要有一段好的开头注释,当然最好还要有自己的风格,让人一看就知道这是你写的,这就是你的门面,你的记号。
喜欢的点个赞❤吧!