[獨自murmur]團隊開發中,Todo註解的重要性

  • 23668
  • 0

[獨自murmur]團隊開發中,Todo註解的重要性

Todo的使用與說明,請參考:

這個動作雖小,但是在團隊開發的情況卻很重要。

每一次commit上版本控管的Repository(本篇文章以Subversion為例)的source code,都應該保證可以建置成功,
SVN上的baseline,應該不管任何人只要update最新的程式下來,都要可以建置成功。

當developer有開發到一半的程式要上SVN,
應該要做的事情:

  1. 將目前的code修正至可以建置成功的狀態
  2. 將尚未完成的部分補上Todo的註解,讓所有get最新程式下來的成員可以知道哪些部分是尚未完成。
  3. 將這些尚未完成的註解,加上去SVN commit comment上


這樣,即使不是在本案開發的人員,從SVN update最新的程式下來,才不需要玩猜猜看,
也可以幫助自己瞭解程式的完成程度到哪,有哪一些todo尚未完成。

如圖所示,在工作清單上,reviewer可以瞭解整個solution中還有哪些issue尚未完成,也可以快速的移至該程式的該行註解:

TaskList

當todo的task完成後,也會養成習慣,將該註解清除。

這也是為什麼很多自動gen出來程式的殼,通常會補上//todo的註解,來提醒developer這一段程式尚未完成。


blog 與課程更新內容,請前往新站位置:http://tdd.best/