03 程式注釋

2021-10-01 21:01:43 字數 983 閱讀 8914

程式注釋主要功能是讓你所設計的程式可讀性更高,更容易了解。在企業工作,乙個實用的程式可以很容易超過幾千或者幾萬行,此事你可能需要設計好幾個月,程式加上注釋,可方便你或他人,未來較方便的了解程式內容。

# -*- coding: utf-8 -*-

# @date: 2020/1/2 12:20

# @author: blueheart

# @blog:

# 這是第乙個單行注釋

print

("hello world !"

)

為了保證**的可讀性,#後面建議先新增乙個空格,然後再編寫相應的說明文字

print

("hello python"

)# 輸出 `hello python`

"""

這是乙個多行注釋

在多行注釋之間,可以寫很多很多的內容……

"""print

("hello world !"

)

注釋不是越多越好,對於一目了然的**,不需要新增注釋

對於複雜的操作,應該在操作開始前寫上若干行注釋

對於不是一目了然的**,應在其行尾新增注釋(為了提高可讀性,注釋應該至少離開** 2 個空格)

絕不要描述**,假設閱讀**的人比你更懂 python,他只是不知道你的**要做什麼

在一些正規的開發團隊,通常會有**審核的慣例,就是乙個團隊中彼此閱讀對方的**

任何語言的程式設計師,編寫出符合規範的**,是開始程式生涯的第一步

注釋轉換程式

這個程式的目的是 把c注釋全部轉換為c 注釋 程式有以下幾個狀態 1 無狀態 的正文部分2 c狀態 注釋方式為c注釋3 c 狀態 注釋方式為c 注釋4 end 結束狀態 這幾種狀態的關係 首先我們要開啟input.c檔案,對這個檔案內部的檔案進行讀取,然後處理,否則直接提示使用者有錯誤。接下來,我們...

程式的注釋

一 注釋的目的 1.為了讓程式更方便閱讀 可讀 以便於維護。二 需要注釋的內容 1.重要變數名的作用 用來表示什麼 2.比較複雜的演算法思想 3.程式中的關鍵步驟 三 注釋的方式 一 有兩種注釋方式 1.單行注釋 在行尾,或 的上一行 在 的下一行也可以,但很少有人這麼做。2.多行注釋 不支援巢狀。...

「程式段」注釋方法

說到程式的注釋,一般情況下大家都會想到 或者 今天我介紹一下對於程式段的注釋,應該使用的兩種方法 1 對於很長一段程式,一般我們用 直接在程式段的開始和結尾處標記即可 都很熟了,不做過多的解釋 2 由於c c 不支援注釋的巢狀,我們一般選擇 if 0.endif語句 所以當你想要注釋一大段的程式時,...