在閱讀源碼和開發過程中,都遇見過別人寫的TODO註釋。按照字面理解就是將要做什麼,一直理解就是解釋該註釋下面的代碼幹了什麼。後來不經意間看到了別人寫的文章,原來不止是這麼簡單。下面就把我整理的一部分註釋跟大家分享一下。
TODO:該註釋下方的代碼將要實現的功能
FIXME:該註釋下方的代碼可能不滿足後來的需求,需要進行修改
HACK:該註釋下方的代碼需要根據自己的需求去調整程序代碼
BUG:該註釋下方的代碼存在bug
這一些是我們通常約定好的註釋,大家一看就能明白。其實我們也可以自定義註釋,方便自己開發。
自定義註釋