?? 函數(shù)頭部注釋編寫規(guī)范.txt
字號:
編寫日期:2011.09.24
1、C\C++函數(shù)頭部注釋編寫規(guī)范:
/*********************************************************************
*函 數(shù) 名:xxxxx
*描 述:
*輸入?yún)?shù):
*輸出參數(shù):
*返 回 值:
*注 意:
**********************************************************************/
/*********************************************************************
*Function : xxxxx
*Description:
*Input :
*Output :
*Return :
*Notes :
**********************************************************************/
2、匯編函數(shù)頭部注釋編寫規(guī)范
;*********************************************************************
;*函 數(shù) 名:xxxxx
;*描 述:
;*輸入?yún)?shù):
;*輸出參數(shù):
;*返 回 值:
;*注 意:
;*********************************************************************
;*********************************************************************
;*Function : xxxxx
;*Description:
;*Input :
;*Output :
;*Return :
;*Notes :
;*********************************************************************
說明:
描述:描述函數(shù)功能及性能
輸入?yún)?shù):輸入?yún)?shù)的作用,取值及參數(shù)間關(guān)系說明
輸出參數(shù):函數(shù)參數(shù)以指針的形式傳遞,修改指針指向的內(nèi)容以輸出值
注意:調(diào)用本函數(shù)須注意的事項(xiàng)
?? 快捷鍵說明
復(fù)制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -