Python 技巧篇-开头注释怎么写最好,开头注释需要包含什么,开头注释的重要性
时间:2022-07-25
本文章向大家介绍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 一点影响也没有,多么两全其美!
一个好的程序员,当然要有一段好的开头注释,当然最好还要有自己的风格,让人一看就知道这是你写的,这就是你的门面,你的记号。
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- 网络工程师提高篇 | 路由重发布你了解多少?从原理到配置,瑞哥带你学习一波!
- 短视频APP开发,简单计时功能
- LeetCode | 94.二叉树的中序遍历
- Druid 的整合
- LeetCode | 104.二叉树的最大深度
- Flutter 目录结构和项目资源
- iOS音视频接入- TRTC互动直播
- 【一天一大 lee】查找常用字符 (难度:简单) - Day20201014
- 金九银十准备换场地?对标腾讯T3的Android高级工程师面试大纲及时雨来了
- 【一天一大 lee】两两交换链表中的节点 (难度:中等) - Day20201013
- 【一天一大 lee】二叉搜索树的最小绝对差 (难度:简单) - Day20201012
- 有奖互动 | 腾讯云开发者社区 3 周年庆,我过生日,送你们礼物 ~
- 【一天一大 lee】分割等和子集 (难度:中等) - Day20201011
- 【一天一大 lee】寻找两个正序数组的中位数 (难度:困难) - Day20201003
- 【一天一大 lee】颜色分类 (难度:中等) - Day20201007