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 一點影響也沒有,多么兩全其美!
一個好的程序員,當然要有一段好的開頭注釋,當然最好還要有自己的風格,讓人一看就知道這是你寫的,這就是你的門面,你的記號。
喜歡的點個贊?吧!
總結
以上是生活随笔為你收集整理的Python 技巧篇-开头注释怎么写最好,开头注释需要包含什么,开头注释的重要性的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Python 技巧篇-字符串灵活处理:字
- 下一篇: Windows 技术篇-搜狗输入法中文状