《**整潔之道》——「注釋」
陳德勝2013-12-27 整理
關於「注釋」的一些原則：
1 注釋不能美化糟糕的**，與其花時間編寫解釋你搞出的糟糕的**的注釋，不如花時間清潔那堆糟糕的**；
2 用**本身來闡述其行為；
3 好注釋包括：
1）與法律相關的注釋；
2）提供基本資訊的注釋；
3）對某個決定的意圖的解釋；
4）對某些晦澀難明的引數或返回值的意義翻譯為某種可讀的形式；
5）用於警告其他程式設計師會出現某種後果的注釋；
6）todo注釋，todo是一種程式設計師認為應該做，但是還沒有做的工作；
7）放大某種看來不合理之物的重要性；
8）公共api的說明文件；
4 壞注釋包括：
1）喃喃自語。如果你決定寫注釋，就要花必要的時間確保寫出最好的注釋；
2）多餘的注釋；
3）誤導性的注釋；
4）循規蹈矩式注釋。所謂每個函式或每個變數都要有注釋的規矩全然是愚蠢可笑的；
5）日誌式注釋。有人會每次編輯**時，在模組開始出新增一條注釋。這類注釋就像是一種記錄每次修改的日誌，這種冗長的記錄只會讓**變的凌亂不堪，應當全部刪除；
6）廢話注釋。用整理**的決心替代創造廢話的衝動吧，你會發現自己成為更優秀、更快樂的程式設計師；
7）能用函式或變數時就別用注釋；
8）位置標記。有時候程式設計師喜歡在源**中標記某個特別位置，但是這種標記盡量少使用，只在特別有價值的時候用；
9）括號後面的注釋。如果你發現自己想標記右括號，其實應該做的是縮短函式；
10）歸屬和署名。源**控制系統是這類資訊最好的歸屬地；
11）注釋掉的**。直接把**注釋掉是討厭的做法，別這麼幹；
12）非本地資訊。假如你一定要寫注釋，請確保它描述了離他最近的**；
13）資訊過多。別在注釋中新增有趣的歷史性話題或者無關的細節描述；
14）不明顯的聯絡。注釋及其描述的**之間的聯絡應該顯而易見。如果你不嫌麻煩要寫注釋，至少讓讀者能看著注釋和**，並且理解注釋所談何物；
15）函式頭。短函式不需要太多描述。為只做一件事的段函式選個好名字，通常要比寫函式頭注釋要好。
java DOM 注意事項
1.w3c把標籤內的文字部分也定義成乙個node 2.element物件代表的是xml文件中的標籤元素 繼承於node，亦是node的最主要的子物件 3.attr實際上是包含在element中的，它並不能被看作是element的子物件，因而在dom中attr並不是dom樹的一部分，所以node中的 ...
static注意事項
static關鍵字是c,c 中都存在的關鍵字,它主要有三種使用方式,其中前兩種只指在c語言中使用,第三種在c 中使用 c,c 中具體細微操作不盡相同,本文以c 為準 1 區域性靜態變數 2 外部靜態變數 函式 3 靜態資料成員 成員函式 下面就這三種使用方式及注意事項分別說明 一 區域性靜態變數 在...
CSS注意事項
一 寬度 高度 對齊方式請別忘記他們 只要你時刻記得 div css 不變形的秘密你已經掌握了 90 也有對齊方式哦！一定要掌握當 對齊方式不同是 布局出現的問題！左右左 能不變形嗎？預設 是要換行的哦 div css的 居中對齊 是有條件的哦 所有當同級元素的對齊方式都為居中對齊的時候可以採用居中...