注釋的反面教材

2021-07-31 22:59:11 字數 485 閱讀 5934

都說好注釋應該寫why而不是how，這裡給個只寫how的廢話注釋作為反面教材。

mingdu.zhengatgmaildotcom

void


spiritradiosetmodulation


(modulationselect xmodulation)
上面這段**裡的注釋是不是都是廢話呢。典型的為了寫注釋而寫注釋，**本身的可讀性已經非常強了，看**本省就足夠理解**了，何必再寫多餘的注釋？4行注釋都是how型注釋。所謂how型注釋是解釋**是怎麼工作的，why型注釋是解釋**為什麼要這麼寫。how型的注釋是完全沒有必要的。可讀性強的**，閱讀**本省就可以理解**是怎麼工作的，寫注釋去解釋可讀性差的**還不如想想怎麼改進**的可讀性呢。優秀的**應該是自注釋的（self-documenting code），就是說**自己能把自己解釋清楚，不用注釋來瞎攙和。

外語教材的選用

學習外語該選什麼樣的教材，這是希望學好外語的人常犯嘀咕的事情。我希望從兩個方面正反說明這個問題，然後談談常見的誤區。首先，任何一套教材，都是系統地 有順序地提供 語言素材 以供學生研習。這裡大家看看流行的各種教材就明白，他們課文內容哦可能差異很大，但教授的 語法點 或 完成任務的能力 卻基本相同，甚...

CAD的正反面片以及轉換程式

在cad中，一般的麵片都是3d face。3d face是由四個頂點形成，在實際運用中為了能更好的顯示，一般將這四個點中的兩個點重合，形成三角形。在cad中，一般認為，如果繪製面的時候是按逆時針方向，則為正面，反之為反面。具體來說就是，如果3d face地四個頂點是按照逆時針方向的順序排列，則該面為...

指向指標的指標（教材）

8.7.3 指向指標的指標 指向指標的指標也稱為二級指標，它指向的是指標型的資料。定義指向指標的指標變數的格式為 資料型別 指標變數名稱 下面通過乙個例項說明指向指標的指標變數的用法。main char p p parray printf n for i 0 i 3 i printf s p i 程...