如何寫漂亮的C++評論的例子

也許是愚蠢的問題，但有沒有什麼辦法可以寫好看（短）格式爲C++函數，頭文件，變量寫評論？任何視覺例子？如何寫漂亮的C++評論的例子

2011-05-10 user63898

你良好的意思是看什麼這裏？我這樣做。

int c;//! loop Counter 

/** 
* compares (XOR) two Types 
* return boolean result 
*/ 
bool compare(Type l, Type r);

它的doxygen格式。在評論中有用於記錄代碼的populer格式。 Doxygen是一個，另一個是naturaldocs。還有更多。它的味道。你甚至可能喜歡naturaldocs格式。

/* 
    Function: Compare 
    Compares two Types 
    Parameters: 
     l - lhs 
     r - rhs. 
    Returns: 
     boolean result 

*/ 
bool compare(Type l, Type r);

DOC++格式也是similer like。

/** Comparison 
    Compare two Types 

    @param l Type lhs 
    @param r Type rhs 
    @return boolean result 
*/ 
bool compare(Type l, Type r);

只使用一種格式，並堅持使用它。

來源

2011-05-10 05:36:27

我更喜歡用這種風格：

/** 
* Class name 
* Description 
*/ 

class MyClass{ 

}

來源

2011-05-10 05:29:44 Headshota

+1，我更喜歡這個評論，這是非常典型的日食。 – iammilind 2011-05-10 05:34:02

這不是'/ **'是[Doxygen]（http://www.doxygen.org/）的一個指標嗎？ – Xeo 2011-05-10 05:36:49

不能說，我不知道=）。但這是我最喜歡的風格。這很簡單，非常漂亮。 – Headshota 2011-05-10 05:40:39

最好的辦法是做這樣的方式，一些自動化工具可以提取它們，並創建交聯的文檔。看看Doxygen

來源

2011-05-10 05:30:02 Eelke

看看http://www.stack.nl/~dimitri/doxygen/。基本上，JavaDoc格式的起飛在格式被解釋的某種程度上可以用於幫助文件。

我是一個自我記錄代碼的信徒，但一些精通的評論可以幫助很多。

來源

2011-05-10 05:32:15 Jahmic

我用下面的風格：

的方法：

/** 
* Method description. 
* @param param1 param1 description 
* @param param2 param2 description 
* @return return description 
* @since date since method is created 
* @author who have made this method. 
*/

變量：

/** variables description **/

類：

/** 
* Class description. 
* @since date since class is created 
* @author who have made this class. 
*/

來源

2011-05-10 05:34:51

有人會建議最美麗的評論是那些在整個計劃中一致的評論。我傾向於使用正斜槓：

// -- short concise comments in single lines like this 

// ----------------------------------------- 
// 
// Sectional Dividers Like This 
// 
// -----------------------------------------

也就是說，如果您希望從您的評論中生成文檔，這些將無濟於事。

來源

2011-05-10 05:36:31 JeremyFromEarth

如何寫漂亮的C++評論的例子

回答

相關問題