python注釋規范
功能要求
為Python代碼添加註釋，對Python程序代碼進行說明。
實例代碼
'''多行注釋開始
下面的代碼根據變數x的值計算y
注意代碼中使用縮進表示代碼塊
多行注釋結束'''
x = 5
if x > 100:
y = x * 5 - 1 # 單行注釋：x>100時執行該語句
else:
y = 0 # x <= 100時執行該語句
print(y) # 輸出y
運行結果
知識說明
注釋用於為程序添加說明性的文字，幫助程序員更好的閱讀和理解程序代碼。Python解釋器會忽略注釋的內容，即注釋的內容不會被Python解釋器執行。
Python注釋分為單行注釋和多行注釋。
單行注釋以符號「#」開始，當前行中符號「#」及其後的內容為注釋語句。單行注釋可以獨佔一行，也可放在語句末尾。 說明： 在Pycharm中使用「ctrl + /」可以添加/取消單行注釋。
多行注釋是用3個英文單引號「'''多行注釋文本'''」或3個雙引號「"""注釋文本"""」進行注釋。 注意： 由一對三個單引號或一對三個雙引號括起來的內容被認為是注釋，但不能由三個單引號和三個雙引號混合使用。
『貳』 Python單行注釋和多行注釋怎麼寫，需要注意什麼
1 單行注釋（行注釋）
以 # 開頭，# 右邊的所有東西都被當做說明文字，而不是真正要執行的程序，只起到輔助說明作用,如：
print("hello python") # 輸出 `hello python`
注意：為了保證代碼的可讀性，# 後面建議先添加一個空格，然後再編寫相應的說明文字；為了保證代碼的可讀性，注釋和代碼之間 至少要有 兩個空格。
2 多行注釋（塊注釋）
要在 Python 程序中使用多行注釋，可以用 一對 連續的 三個 引號(單引號和雙引號都可以)，如：
"""
這是一個多行注釋
在多行注釋之間，可以寫很多很多的內容……
"""
print("hello python")
提示：
注釋不是越多越好，對於一目瞭然的代碼，不需要添加註釋
對於 復雜的操作，應該在操作開始前寫上若干行注釋
對於 不是一目瞭然的代碼，應在其行尾添加註釋（為了提高可讀性，注釋應該至少離開代碼 2 個空格）
絕不要描述代碼，假設閱讀代碼的人比你更懂 Python，他只是不知道你的代碼要做什麼 （BY三人行慕課）
『叄』 python多行注釋是什麼
python多行注釋是：用來向用戶提示或解釋某些代碼的作用和功能，它可以出現在代碼中的任何位置。Python 解釋器在執行代碼時會忽略注釋，不做任何處理，就好像它不存在一樣。
千萬不要認為你自己寫的代碼規范就可以不加註釋，甩給別人一段沒有注釋的代碼是對別人的不尊重，是非常自私的行為；你可以喜歡自虐，但請不要虐待別人。
python學習方法：
很多程序員寧願自己去開發一個應用，也不願意去修改別人的代碼，沒有合理的注釋是一個重要的原因。雖然良好的代碼可以自成文擋，但我們永遠不清楚今後閱讀這段代碼的人是誰，他是否和你有相同的思路；或者一段時間以後，你自己也不清楚當時寫這段代碼的目的了。
給代碼添加說明是注釋的基本作用，除此以外它還有另外一個實用的功能，就是用來調試程序。舉個例子，如果你覺得某段代碼可能有問題，可以先把這段代碼注釋Python 解釋器忽略這段代。
『肆』 Python函數註解使用有哪些注意事項呢
函數註解是關於用戶自定義的函數的完全可選的、隨意的元數據信息。
1.無論 Python 本身或者標准庫中都沒有使用函數註解；本節只是描述了語法。第三方的項目是自由地為文檔，類型檢查，以及其它用途選擇函數註解。
2.註解是以字典形式存儲在函數的 __annotations__ 屬性中，對函數的其它部分沒有任何影響。參數註解（Parameter annotations）是定義在參數名稱的冒號後面，緊隨著一個用來表示註解的值得表達式。返回注釋（Return annotations）是定義在一個 -> 後面，緊隨著一個表達式，在冒號與 -> 之間。下面的示例包含一個位置參數，一個關鍵字參數，和沒有意義的返回值注釋:
>>> def f(ham: 42, eggs: int = 'spam') -> "Nothing to see here":
... print("Annotations:", f.__annotations__)
... print("Arguments:", ham, eggs)
...
>>> f('wonderful')
Annotations: {'eggs':
, 'return': 'Nothing to see here', 'ham': 42}
Arguments: wonderful spam
『伍』 python的基本語法是什麼
語法規則，條件語句、循環語句、方法、類那些。基本內數據類型，Python是弱類型需要容，但還是有類型的，這些類型的特點及操作。內置庫API的使用，比如sqlite、網路請求庫、json等。
Python由荷蘭數學和計算機科學研究學會的Guido van Rossum於1990 年代初設計，作為一門叫做ABC語言的替代品。
Python提供了高效的高級數據結構，還能簡單有效地面向對象編程。Python語法和動態類型，以及解釋型語言的本質，使它成為多數平台上寫腳本和快速開發應用的編程語言，隨著版本的不斷更新和語言新功能的添加，逐漸被用於獨立的、大型項目的開發。
Python解釋器易於擴展，可以使用C或C++（或者其他可以通過C調用的語言）擴展新的功能和數據類型。 Python 也可用於可定製化軟體中的擴展程序語言。Python豐富的標准庫，提供了適用於各個主要系統平台的源碼或機器碼。
2021年10月，語言流行指數的編譯器Tiobe將Python加冕為最受歡迎的編程語言，20年來首次將其置於Java、C和JavaScript之上。
『陸』 python代碼為什麼有下劃波浪線
python代碼的注釋下面帶波浪線的問題：
python代碼的注釋格式應該是#空格注釋，否則注釋下面就會帶有波浪線，雖然不加空格也不影響程序運行，但是不符合注釋規范。
python編輯器pycharm代碼有下劃波浪線：
解決方法：
點擊file--settinng，找到Inspections，取消勾選右側python：
更多Python知識請關注Python自學網。
『柒』 python注釋規范
確保對模塊, 函數, 方法和行內注釋使用正確的風格
參考：Python風格規范 — Google 開源項目風格指南
文檔字元串
模塊
函數和方法
Args :
Returns: (或者 Yields: 用於生成器)
Raises:
類
塊注釋和行注釋
『捌』 Python教程：單行多行注釋
工具/材料
python
- 01
在python中使用#號表示單行注釋
- 02
使用""" """或''' '''做為多行注釋
- 03
單行注釋和多行注釋不宜過多,不是每行代表都要注釋,最好用來解釋函數的操作
- 04
以下是一些錯誤使用注釋的方式,一些能直接看到結果的代碼最好不要多寫注釋
特別提示
關鍵代碼,復雜代碼使用注釋