開頭注釋除了必要的資訊外,一些簡單的介紹也是尤為重要呢,比如作者、建立日期、更新日期、裡面代碼大體是實作什麼功能的簡要介紹。這些介紹不但是規範,更是一種認真工作态度的展現。
下面給大家展示一下我的開頭注釋是怎麼寫的。
#!/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 一點影響也沒有,多麼兩全其美!
一個好的程式員,當然要有一段好的開頭注釋,當然最好還要有自己的風格,讓人一看就知道這是你寫的,這就是你的門面,你的記号。
喜歡的點個贊❤吧!