一個好的程序,注釋的占比大概是代碼量的30%。勤寫注釋不僅僅是讓別人易于閱讀你的代碼,更重要的是在一定時間后,你也還知道你當初是如何實現的。
勤寫注釋,不是說注釋越多越好;勤寫注釋,也要講究策略。好的注釋,一般應該出現在可能存在歧義的地方,或者做了某些特殊處理的地方。
不過遺憾的是,工作這么多年一直沒有遇到注釋寫得很好的自研項目。更多的是要么注釋很少,要么就是寫了很多無用的注釋。
一個好的程序,注釋的占比大概是代碼量的30%。勤寫注釋不僅僅是讓別人易于閱讀你的代碼,更重要的是在一定時間后,你也還知道你當初是如何實現的。
勤寫注釋,不是說注釋越多越好;勤寫注釋,也要講究策略。好的注釋,一般應該出現在可能存在歧義的地方,或者做了某些特殊處理的地方。
不過遺憾的是,工作這么多年一直沒有遇到注釋寫得很好的自研項目。更多的是要么注釋很少,要么就是寫了很多無用的注釋。