從項目的整體風格考慮,對所有類要進行必要的說明,就注釋說明來說首先需要說明是作者,檔案建立時間,業務功能說明,這幾項是基本的内容,而添加這些說明内容以前可能手動的添加檔案标題頭,這種做法現在都非常過時了。
通過studio可以配置有關的file header達到自動添加的目的。
配置的方式如下圖

/**
* Created by ${USER} on ${DATE} ${TIME}.
* describe 該類主要完成以下功能
* 1.主要功能
*/
下面讨論下這個類還可能需要那些說明。
首先應該有版本變遷說明,每個版本發生了那些變動,增、改、删了那些業務功能,并對這些修改内容進行必要的描述。
其次應該有修訂人說明,以及修訂人聯系方式,友善日後溝通。
是以,綜上所述,file header設定為下面。
/**
* Created by ${USER} on ${DATE} ${TIME}.
* describe 該類主要完成以下功能
* 1.主要功能
* change info: v1.0 建立
* v1.1 增加直播功能
* modify by tony [email protected]
*
*/
一家之言,供大家參考。