新聞中心

EEPW首頁(yè) > 嵌入式系統(tǒng) > 牛人業(yè)話 > 一線研發(fā)之聲 之 C代碼注釋引發(fā)的“血案”

一線研發(fā)之聲 之 C代碼注釋引發(fā)的“血案”

作者: 時(shí)間:2014-07-30 來源:網(wǎng)絡(luò) 收藏

  我開始思考,還有什么強(qiáng)勁有力的理由,來支持我恪守的真理:c語(yǔ)言代碼必須使用/**/.

本文引用地址:http://butianyuan.cn/article/256102.htm

  有的!

  倘若所有代碼里面的用到/**/時(shí),當(dāng)你要掉這段代碼時(shí),如果不想忍受的嵌套報(bào)警,又懶得把一個(gè)個(gè)/**/換成//的話。那么你還有如下選擇。

  1) 慎重思考下是否刪光這段代碼,如果還有些不舍,那就先"備份"(git推送)一下再刪光。因此,

  理由一:使用/**/注釋代碼,會(huì)使軟件系統(tǒng)減少冗余的僵尸代碼,鼓勵(lì)程序員的程序備份行為。

  2) 或者用編譯條件圈起來,如下。

  #if (XXX_ENABLE)

  func(a, b, c); /* 注釋 */

  ...... /* 注釋 */

  #endif

  那么你不得不考慮xxx的命名,如何更加一目了然,再寫點(diǎn)注釋什么的,表明對(duì)這段代碼“棄而不舍”的緣由。因此,

  理由二:使用/**/注釋代碼,會(huì)鼓勵(lì)程序員刪除代碼時(shí),三思而后行,并且注明舍棄的理由。

  3) 當(dāng)然,偷懶的人還是會(huì)用 #if 0 #endif圈起來, 如下,

  #if 0

  func(a, b, c); /* 注釋 */

  ...... /* 注釋 */

  #endif

  而且不會(huì)寫任何注釋表明刪除的理由。然而,“#if 0”是一個(gè)如此的醒目,很容易成為一個(gè)評(píng)估軟件質(zhì)量、工作績(jī)效的搜索關(guān)鍵詞。從管理的角度,這個(gè)是可以量化的。因此,

  理由三: 使用/**/注釋代碼,有利于公司進(jìn)行軟件質(zhì)量控管,對(duì)程序員績(jī)效考核。

  這三個(gè)理由,足夠?yàn)樽约捍詥?

c語(yǔ)言相關(guān)文章:c語(yǔ)言教程


c++相關(guān)文章:c++教程



上一頁(yè) 1 2 下一頁(yè)

關(guān)鍵詞: C代碼 注釋 編譯器

評(píng)論


相關(guān)推薦

技術(shù)專區(qū)

關(guān)閉