1. 程式人生 > >C/C++常用的檔案函式註釋格式

C/C++常用的檔案函式註釋格式

下面是我經常使用的兩個註釋格式,一個用於檔案資訊註釋,一個用於函式資訊註釋,謝謝大家

/***************************************************************



 * @file       程式檔案的名稱

 * @brief      程式檔案的功能

 * @author     作者

 * @version    版本號

 * @date       日期



 **************************************************************/
/***************************************************************



  *  @brief     函式作用

  *  @param     引數   

  *  @note      備註

  *  @Sample usage:     函式的使用方法 



 **************************************************************/