3.1 開頭註釋
所有的源文件都應該在開頭有一個C語言風格的註釋,其中列出類名、功能、版本信息、日期、作者和版權聲明:
/*
* 類名
* 功能
* 版本
* 日期
* 作者
* 版權
*/
如果對文件進行瞭修改,應該在文件頭中說明修改目的、修改日期、修改人,並變更文件的版本信息;如果修改問文件的一部分,則在文件中進行註釋即可,並且標識出修改部分的起止位置
……
/*
* 修改目的
* 修改日期
* 修改人
* 版本
*/
……
修改起始
……
……
修改結束
……