久久久久久久999_99精品久久精品一区二区爱城_成人欧美一区二区三区在线播放_国产精品日本一区二区不卡视频_国产午夜视频_欧美精品在线观看免费

標題: C/C++注釋范本 [打印本頁]

作者: shaonv 時間: 2015-1-1 23:43
標題: C/C++注釋范本
據業內分析程序員大部分時間是花費在看代碼中，而寫代碼往往占不到一半，由此可見代碼編寫者非常有必要遵循一些規范，也是便于代碼的維護。
首先這里先貼出我總結的一個注釋范本：
// 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
/* * * */

是的，你看到的沒有任何中文字。筆者不推薦寫注釋使用中文，一是不國際化，二是目前還存在不支持中文的編譯器，三是不利于代碼的移植（平臺對中文的支持程度不同，會造成顯示亂碼等）。所以程序員還是老老實實的用英文寫注釋吧，而且還能增強自己的英文水平。一舉多得，何樂而不為。
下面是我給大家舉的幾個注釋的例子：
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    :
*****************************************************************
*/
這個注釋是比較簡單的，在  @Details一欄并沒有詳細的講述此文件所做的工作，程序員在注釋文件頭的時候可以比較詳細的敘述此文件所能完成的功能

2.函數注釋
/*
****************************************************************
* @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
****************************************************************
*/
以上是對設置跑馬燈的速度的一個函數，函數名是 UserSetMarqueeRates，輸入參數只有1個，速度的模式值，簡單明了，閱讀這一看便知道此函數的作用

總結：為什么要注釋這里就不再去搬大道理了，很簡單，你的記憶力有限，代碼不可能永遠是你一個人在維護。牽扯到時間和團隊的維護，形成一個良好的編程風格是對一個程序員的一個考驗。堅持做下去，你就是一個好的程序員。

歡迎光臨 (http://m.zg4o1577.cn/bbs/)