1. 程式人生 > >Doxygen和VS助手配置程式碼註釋模板

Doxygen和VS助手配置程式碼註釋模板

Title:FileNote
Shortcut:#filenote
Description:檔案註釋
/**
*  Copyright (c) $YEAR$, xx科技有限公司(http://blog.csdn.net/stelalala)
*  All rights reserved.
*
*  @file        $FILE_BASE$.$FILE_EXT$
*  @author      張三([email protected])
*  @date        $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$
*
*  @brief       $brief$
*  @note        無
*
*  @version
*    - v$VerNO$    $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$    張三    $VerNoBrief$
*/
說明:新檔案版本新增到已有版本的前面,格式如後面的“新版本說明”

Title:ClassNote
Shortcut:#classnote
Description:類註釋
/**
*  @author      張三([email protected])
*  @date        $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$
*  @class       $classname$
*  @brief       $brief$
*  @note        無
*/

Title:FuntionNote
Shortcut:#funnote
Description:函式註釋
    /**
    *  @date        $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$
    *  @brief       $brief$
    *  @param[in]   
    *  @param[out]  
    *  @return      成功返回true,否則為false
    *  @pre         
    *  @remarks     
    *  @see         
    */
說明:如果沒有對應資訊,可將部分欄位刪除。私有成員函式建議去掉最後三個欄位。

Title:MemberNote
Shortcut:#memnote
Description:結構體、列舉、成員變數等註釋
/** $VariableNote$ */	放在被註釋物件上面
/**< $VariableNote$ */	放在被註釋物件後面

Title:NewVerBrief
Shortcut:#newver
Description:新版本說明
*    - v$VerNo$    $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$    張三    


Title:date
Shortcut:#date
Description:獲取當前時間
$YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$    

參考資料:
1、通過vc助手設定快捷註釋
2、在Visual Assist X中增加Doxygen格式的註解的模板 [RT,修改]
3、Doxygen詳細介紹(三)(Doxygen註釋風格)
4、Doxygen風格註釋類、成員、函式
5、本部落格其他關於Doxygen的介紹

相關推薦

DoxygenVS助手配置程式碼註釋模板

Title:FileNote Shortcut:#filenote Description:檔案註釋/** * Copyright (c) $YEAR$, xx科技有限公司(http://blog.csdn.net/stelalala) * All rights res

開發工具Eclipse-程式碼註釋模板

點選選單Window->Preferences彈出首選項設定視窗 展開左側Java->Code Style->Code Template選項列表,就可以看到所有需設定註釋的元素了 展開右側模板選項Comments,可以看到可以設定的註釋模板型別,包含Files,Types,F

eclipse/sts 程式碼註釋模板

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="true" context="gettercomment_context

JAVA程式碼註釋模板

首先,先建一個空的XML檔案,然後將以下的程式碼複製進去!下面的註釋中包括了日常中使用頻繁的程式碼註釋模版!模板裡面的名字,版本等等資訊需要修改為自己的資訊! <?xml version="1.0" encoding="UTF-8"?><templa

MyEclipse設定Java程式碼註釋模板

定義自己喜歡的模板註釋 選中你要加註釋的方法或類,按 Alt + shift + J。   檔案 (Files)註釋標籤: /**    * @Title:

Idea 配置method註釋模板

idea中配置class、interface上的註釋模板配置這裡不再說明,主要說明如何配置方法上的註釋,效果如下 /** * @description TODO: * @param regUserId * @param idCard * @param r

好玩的程式碼註釋模板

圖片轉字元的一個工具:戳這裡 /** * .,:,,,

IDEA配置註釋模板(類方法)

背景 程式碼程式設計規範:註釋,註釋,方便後來者的程式碼閱讀和責任出處 IDEA類註釋模板配置 1、開啟File-->Settings-->Editor-->File and Code Templates,選擇Includes下面的File Header

使用jdbc驅動.properties配置檔案獲取資料來源的程式碼(註釋詳細,值得一看)

package util; import java.io.InputStream; import java.util.Properties; import javax.sql.DataSource;

程式碼註釋規範-IDEA 配置 Java 類方法註釋模板

1. 引言     團隊開發時,業務模組分配的越清晰,程式碼註釋管理越完善,越有利於後面維護,後面再管理也方便不少。另外也起著"文字磚"的作用,你懂的。註釋不需要很詳細,把程式碼塊方法塊功能簡述一下就行。不然三月後回頭看就要罵人了,罵完發現是自己寫的,嘖嘖嘖...     三種常用的 Ja

apache主配置文件模板基於域名虛擬主機配置文件模板

apache主配置文件模板 默認配置文件模板 禁止ip訪問 基於域名虛擬主機配置文件模板 記錄代理ip1,主配置文件模板 # cat httpd.conf ServerRoot "/usr/local/apache" Listen 80 LoadModule authn_file_module mo

Interllij IDEA 註釋模板(類方法)

生成 eight 否則 return pla mage clas templates rip 類上的註釋:   file->setting->Editor->Filr and Code Templates->Includes->File Hea

Eclipse設置註釋模板工作空間背景色為豆沙綠

scrip png col .com system eclipse 圖片 ons pear Eclipse Version: Photon Release (4.8.0)。 首先上圖,根據圖上的步驟即可完成註釋模板的設置。 1 如何設置eclipse註釋模板的日期格式

Java規範化程式碼eclipse模板註釋

建議下載阿里規範化外掛 阿里的new java file的註釋模板(Type): /**  * @author ${user}  * @date ${currentDate:date('YYYY/MM/dd')}  */  

idea超詳細設定之類註釋模板方法註釋模板

設定類註釋模板 1.選擇File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header. 2.在右邊空白處,編寫自己的模板即可,注意Scheme是模板的生效範圍,可選變數在

超詳細設定 Idea 類註釋模板方法註釋模板

網上找了一下,沒有很詳細且正確介紹Idea配置註釋模板的,於是結合多篇文章自己琢磨整理出如下。 設定類註釋模板 1.選擇File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header.&n

Eclipse 程式碼添加註釋模板

        好的習慣養成好的程式碼書寫規範,同樣好得程式碼模組註釋也同樣重要,不管是對於開發人員還是後期運維人員,都能清楚得知道你得想法,對於程式碼模組註釋今天我就來介紹一下。 (第一種) 1.Window——>Preferences——&g

idea 類註釋 方法註釋 模板 制定

      在用idea寫Java工程程式碼的時候,需要讓idea自動生成一些重複性註釋,這個我們可以通過設定模板的方式來進行設定。 類註釋模板的設定 位置選擇 1、Preferences ——> File

Intellij IDEA 自定義註釋模板 在方法上得到引數返回值

說明 之前配置的註釋模板在方法上得不到引數和返回型別,在網上找了好多方法,如在param和returnType設定groovyScript指令碼,但仍然無法獲取。最後找到資料,發現是模板格式設定錯誤,在這裡記錄下。 正文 如何建立Live Templates就不在此介紹了。直

Apollo 釋出 GraphQL 平臺 VS 程式碼擴充套件

GraphQL背後的公司Apollo剛剛推出了其旗艦產品Apollo GraphQL 平臺,稱其為“旨在以正確方式進行 GraphQL 的公司的完整解決方案”。GraphQL 已逐漸成為現代應用程式開發的一個有用元件,大型企業都是依賴於專家來實現它。Apolloy 認為這個新平臺可以讓任何應用開發團隊輕鬆