Python 技巧篇-开头注释怎么写最好,开头注释需要包含什么,开头注释的重要性
開頭注釋除了必要的信息外,一些簡(jiǎn)單的介紹也是尤為重要呢,比如作者、創(chuàng)建日期、更新日期、里面代碼大體是實(shí)現(xiàn)什么功能的簡(jiǎn)要介紹。這些介紹不但是規(guī)范,更是一種認(rèn)真工作態(tài)度的體現(xiàn)。
下面給大家展示一下我的開頭注釋是怎么寫的。
#!/user/bin/env python # -*- coding:utf-8 -*- # 作者:小藍(lán)棗 # 創(chuàng)建:2019-03-01 # 更新:2019-03-15 # 用意:用于剪切板內(nèi)容編輯#!user/bin/env python
這行代碼在 unix 類系統(tǒng)里才有用,linux 系統(tǒng)就屬于 unix 類系統(tǒng)。
這是告訴系統(tǒng)要運(yùn)行這個(gè)文件要用什么運(yùn)行。
windows 系統(tǒng)是根據(jù)擴(kuò)展名 .py 來關(guān)聯(lián)的,所以只要是 .py 結(jié)尾,直接就會(huì)用 python 來運(yùn)行;
以前還有這么寫的,直接指明 python 的絕對(duì)位置:#!user/bin/python
因?yàn)?python 有可能不在 bin 下面,env python 是直接找到 python 的安裝位置,更實(shí)用。
# -*- coding:utf-8 -*-
python2 系列默認(rèn)不支持中文,只有使用 utf-8 等支持中文的編碼,才可以使用中文。
python3 系列默認(rèn)就支持中文了,所以無論是什么編碼也沒問題了。
我覺得一段好代碼,應(yīng)該有更好的兼容性,我們寫了這樣的開頭,直接就可以在 linux 下和 python2 下運(yùn)行,這些還是很主流的,而且對(duì)我們的 windows 和 python3 一點(diǎn)影響也沒有,多么兩全其美!
一個(gè)好的程序員,當(dāng)然要有一段好的開頭注釋,當(dāng)然最好還要有自己的風(fēng)格,讓人一看就知道這是你寫的,這就是你的門面,你的記號(hào)。
喜歡的點(diǎn)個(gè)贊?吧!
總結(jié)
以上是生活随笔為你收集整理的Python 技巧篇-开头注释怎么写最好,开头注释需要包含什么,开头注释的重要性的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Python 技巧篇-字符串灵活处理:字
- 下一篇: Windows 技术篇-搜狗输入法中文状