V06 自動補齊註解(1)──格式正確性與基本資訊

註解是人為按照格式輸入的，編輯器會自動檢查註解是否有造成程式編譯不正確的錯誤，但是註解內容的格式就需要另外用工具來判別。除了檢查格式之外，應該同時從預先建立的基本資訊檔裡取得對應的內容自動地放入註解並儲存。

package宣告之前通常應有版權宣告段落，class註解內通常會有since、author、version；Method註解雖然有param、return、throws但是打算也加上since、author等資訊，這是因為Method可能會因重構移動到其它Class裡而造成資訊的錯失。

雖然Eclipse可以匯入標準的註解格式，但是格式可能因不同的需求而修改存放資訊，在需要變動的時候絕對不會有人一一將成千上萬的Class取出來重新調整；同樣地如果有人忘了匯入而造成缺少註解內容，若那人不動聲色地放入儲存庫也不見得有人發現或是會更正。用自動的功能消弭掉人為的誤差讓所有的產出一致無論在什麼領域都是非常重要的事。

整合以上的需要註記的欄位就是應該放在基本資訊檔裡的資訊，這些資訊區分為公司通用（版權宣告）、版本使用（version）、個人專用（author）與時間相關（since、版權宣告裡的年份），設計時依不同用途放置在不同的資料夾中備取。處理時若有缺少的欄位就從資訊檔取得，存在的欄位再定義檢查的規則看是否有誤。