|
|
據(jù)業(yè)內(nèi)分析程序員大部分時(shí)間是花費(fèi)在看代碼中，而寫代碼往往占不到一半，由此可見代碼編寫者非常有必要遵循一些規(guī)范，也是便于代碼的維護(hù)。
首先這里先貼出我總結(jié)的一個(gè)注釋范本：
// File Header Notes
/*
*****************************************************************
* @File Name :
* @Copyright (C/C++)
* @Author :
* @DATE :
* @Brief :
* @Details :
* @Version :
* @Target :
* @ToolChain :
* @Notes :
*****************************************************************
*/
// Function Notes
/*
****************************************************************
* @Function Name :
* @Brief :
* @Details :
* @Param[in] :
* @Param[out] :
* @RetVal :
* @Author :
* @Date :
****************************************************************
*/
// Struct Notes
/*
****************************************************************
* @Brief :
* @Details :
* @Author :
* @Date :
****************************************************************
*/
// Macro Notes
/* * * */
是的，你看到的沒有任何中文字。筆者不推薦寫注釋使用中文，一是不國際化，二是目前還存在不支持中文的編譯器，三是不利于代碼的移植（平臺對中文的支持程度不同，會造成顯示亂碼等）。所以程序員還是老老實(shí)實(shí)的用英文寫注釋吧，而且還能增強(qiáng)自己的英文水平。一舉多得，何樂而不為。
下面是我給大家舉的幾個(gè)注釋的例子：
1.文件頭注釋
/* *****************************************************************
* @File Name : Main.c
* @Copyright (C/C++)
* @Author : Bernie Liu
* @DATE : 2014-02-21
* @Brief : marquee(horse race lamp)
* @Details : User can set the rate and the direction;Key1 set
the rate,Key2 set the direction
* @Version : V0.01
* @Target : C8051F005
* @ToolChain : Keil4
* @Notes :
*****************************************************************
*/
這個(gè)注釋是比較簡單的，在 @Details一欄并沒有詳細(xì)的講述此文件所做的工作，程序員在注釋文件頭的時(shí)候可以比較詳細(xì)的敘述此文件所能完成的功能
2.函數(shù)注釋
/*
****************************************************************
* @Function Name : UserSetMarqueeRates
* @Brief : User set the Marquee's rates
* @Details : rates include 8 modes, 0~8
* @Param[in] : 1）BYTE rates,User set from Key1 tunner
* @Param[out] : Null
* @RetVal : Null
* @Author : Bernie Liu
* @Date : 2014-02-21
****************************************************************
*/
以上是對設(shè)置跑馬燈的速度的一個(gè)函數(shù)，函數(shù)名是 UserSetMarqueeRates，輸入?yún)?shù)只有1個(gè)，速度的模式值，簡單明了，閱讀這一看便知道此函數(shù)的作用
總結(jié)：為什么要注釋這里就不再去搬大道理了，很簡單，你的記憶力有限，代碼不可能永遠(yuǎn)是你一個(gè)人在維護(hù)。牽扯到時(shí)間和團(tuán)隊(duì)的維護(hù)，形成一個(gè)良好的編程風(fēng)格是對一個(gè)程序員的一個(gè)考驗(yàn)。堅(jiān)持做下去，你就是一個(gè)好的程序員。
|
|
QQ好友和群
QQ空間
騰訊微博
騰訊朋友
收藏
淘帖
頂
踩
