如果你多了解一些程式語言，你就能夠發現乙個特別神奇的現象，所有的程式語言都允許你寫注釋，而在很多初學者眼中，注釋並不是什麼重要的東西，學習過程中幾乎沒有太多的關注。
但在實際工作中，注釋是非常重要的，甚至有觀點認為注釋是程式的一部分，為什麼在專業人士眼中，**注釋如此重要呢？其實原因很簡單，你今天寫的**，7天以後你自己都不認識了。
就是這麼不可思議，但又很合理，你還記得7天前晚飯吃的是什麼？**，是你大腦裡邏輯的一種技術呈現，彼時彼刻，你所思所想濃縮成了一行行的**，但是7天以後，這一行行**卻很難反向轉換成你大腦裡的邏輯，這就是寫注釋的必要所在。
注釋的目的是解釋**在做什麼，關鍵性的資訊可以讓你在回顧**時回想起更多的更完整的資訊。
對於初學者，給**寫注釋，更有助於理清**邏輯，讓思維更嚴謹。
單行注釋以 # 開頭，根據規範，注釋內容與# 間隔乙個空格
countdefdef關於這個問題，沒有標準答案，有人很抬槓的說**是最好的注釋，這等於沒說，正是因為寫出好**不是一件容易的事情，所以，才要寫注釋。
結合我自身的工作經驗，我認為好的**注釋應該符合以下幾個特點
描述簡潔，避免長篇大論
保留關鍵上下文資訊
多記錄為什麼，少說是什麼
如果把一段**注釋寫成了議**，那豈不是喧賓奪主，注釋應該簡潔，減輕閱讀負擔。
注釋內容要直觀，比如給乙個函式寫注釋，要簡明的描述函式的功能和作用。
只有寫**的人才了解上下文資訊，而對於維護**的人來說，這些資訊往往是缺失的，比如給乙個函式寫注釋，如果函式是乙個功能函式，那麼注釋應該說清楚它的適用範圍，如果是乙個對外的介面，那麼應該說清楚目前誰在呼叫，入參需要注意的問題是什麼。
保留這些上下文資訊，可以讓接手的人快速的了解這個函式，不至於到處去問人，
和第一條遙相呼應，**做了什麼，簡明扼要的介紹就可以了，但是為什麼要這麼做則需要多做些說明。
如果接手**的人不清楚為什麼要這麼做，很可能會以後你的**寫的有問題，因為他不了解需求背景，他不了解當初寫**時的考慮因素和限制條件，所以，注釋應當為後來人釋疑，讓維護**的人大膽放心的使用，而不是質疑你的**
有道雲筆記note.youdao.com
python注釋 Python基礎 注釋
目標 01.注釋的作用 使用用自己熟悉的語言，在程式中對某些 進行標註說明，增強程式的可讀性 02.單行注釋 行注釋 為了保證 的可讀性，後面建議先新增乙個空格，然後再編寫相應的說明文字 在 後面增加的單行注釋 03.多行注釋 塊注釋 什麼時候需要使用注釋？注釋不是越多越好，對於一目了然的 不需要新...
python注釋 Python 注釋方法
1 def f text str,max len int 0 80 str 這個是函式的幫助說明文件，help時會顯示 return true 函式宣告中，text str text 是引數 冒號後面 str是引數的注釋。如果引數有預設值，還要給注釋，如下寫。max len int 0 80 str...
python注釋格式 Python 注釋
1 注釋 就是一段文本性的描述，用來對 的解釋和說明。2 注釋的特性 當程式被處理的時候，注釋會被自動忽略，不會被當做 處理。3 注釋的作用 幫助自己理清 邏輯。與他人合作開發時，能夠減少溝通成本。開發模組時，可以減少他人的使用成本。臨時注釋一段 可以方便除錯。4 注釋的分類 單行注釋 又叫行注釋 ...