2010年10月18日 星期一

license header template (Qt creator)

大部分的程式開頭,都有一段宣告。像是LGPL、GPL或doxygen的註譯等。
Qt creator提供一個license template的功能,當每次增加新的檔案時,都會在文件最前面加上設定好的字串。
Tools > Options... > C++ > License Template > Browse
選擇文件檔(像是gpl.txt)

以下Qt提供的特殊placeholders

  1. %YEAR%: Year
  2. %DATE%: Date
  3. %USER%: User name
  4. %FILENAME%: File name
  5. %CLASS%: Class name (if applicable)
舉個例子:
/**
* @file %FILENAME%
* @brief define %CLASS% class
*
* Define %CLASS% class.
*
* @author %USER%
*
* @date %DATE%
*/
經過Qt轉換後,就會變成
/**
* @file dictionary.h
* @brief define Dictionary class
*
* Define Dictionary class.
*
* @author http://yycking.blogspot.com/
*
* @date 2010/10/18
*/

沒有留言: