單行注釋
python中單行注釋采用 #開頭
[cc lang='python' ]
print ‘hello python’
#this is a comment
[/cc]
多行注釋
然后python蛋疼的沒有塊注釋,所以現在推薦的多行注釋也是采用的 #比如:
# comments start
#content
#comments end
不過這種風格和標准的Java注釋很像
/**
*java注釋
*/
網上說的什么使用”"” if 0:我個人覺得很不好。。。google python style 中也是采用的#來進行多行注釋
代碼間注釋
這個就直接引用一段 google 的編程規范原文吧
意思就是 不要去刻意對齊注釋,后期維護代碼會增加麻煩
特殊注釋
比如#! /usr/bin/python 這句注釋的意思就是告訴LINUX/UNIX去找到python的翻譯器,大部分文件都不需要這個,只在要求也執行的文件中添加。
關於蛋疼的中文編碼: # coding = utf-8 【注:這句代碼蛋疼的必須放在第二行啊,而且多個空格都不行啊!】
python的福利!!
python在注釋中有一個非常有用的東西是 doc String ,它可以用於模塊、函數和類的描述:(其實總結起來都是類)下面是一個標准的方法注釋
他用 “”"三個引號標識,第一行大寫開頭,作簡要概述,句號結尾,空一行開始詳細的描述。他的好處是 這些注釋保存在方法的__doc__屬性中,可以打印顯示。這個其實和java 的doc也很相似,還記得大明湖畔的@嗎