Python 技巧篇-开头注释怎么写最好,开头注释需要包含什么,开头注释的重要性

简介: Python 技巧篇-开头注释怎么写最好,开头注释需要包含什么,开头注释的重要性

开头注释除了必要的信息外,一些简单的介绍也是尤为重要呢,比如作者、创建日期、更新日期、里面代码大体是实现什么功能的简要介绍。这些介绍不但是规范,更是一种认真工作态度的体现。

下面给大家展示一下我的开头注释是怎么写的。

#!/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 一点影响也没有,多么两全其美!

一个好的程序员,当然要有一段好的开头注释,当然最好还要有自己的风格,让人一看就知道这是你写的,这就是你的门面,你的记号。

喜欢的点个赞❤吧!


目录
相关文章
|
1月前
|
Python
【python从入门到精通】-- 第二战:注释和有关量的解释
【python从入门到精通】-- 第二战:注释和有关量的解释
41 0
|
1月前
|
数据采集 前端开发 Python
Python pygame 实现游戏 彩色 五子棋 详细注释 附源码 单机版
Python pygame 实现游戏 彩色 五子棋 详细注释 附源码 单机版
71 0
|
2月前
|
IDE 开发工具 Python
python3代码编程规范(命名、空格、注释、代码布局、编程建议等)
该文章详细介绍了Python3的编程规范,包括命名、空格使用、注释、代码布局等方面的最佳实践,帮助提升代码的可读性和一致性。
43 0
|
3月前
|
Python
python中注释使用连续的单行注释 #
【8月更文挑战第1天】
49 6
|
4月前
|
开发者 Python
Python中注释用途
【7月更文挑战第28天】
51 6
|
4月前
|
开发者 Python
Python 基础语法注释
【7月更文挑战第27天】
69 6
|
3月前
|
IDE API 开发工具
|
3月前
|
Python
python中注释使用三个引号 """ 或 '''
【8月更文挑战第1天】
313 4
|
4月前
|
语音技术 Python
语音识别,python字面量,注释,变量,python变量的格式是变量名 = 变量值,加减乘除的输入方式
语音识别,python字面量,注释,变量,python变量的格式是变量名 = 变量值,加减乘除的输入方式
|
5月前
|
Python
Python Google风格注释详解
Google风格注释是Python代码注释的一种标准化格式,它提供了一种规范的注释格式,使得代码更加易读、易于维护。Google风格注释使用三个双引号来包围注释内容,并按照一定规范编写。在注释中使用动词短语来描述函数的行为,并使用被动语态。在注释中使用正确的标点符号和缩进,使得注释易于阅读和理解。通过使用Google风格注释,我们可以为代码提供清晰的文档和说明,使得代码更加易读、易于维护。
203 3