如何正確評論c中的方法？

在Java中是否有類似的東西？

/* 
*Returns the value of the sin(x) 
* 
*@param..? 
[email protected]? 
. 

? 
?

謝謝您的建議。比你..

來源

2013-11-22 JaLe29

C（AFAIK）中沒有方法 – haccks

有作爲「評論有道」沒有這樣的事 - 評論不在乎，而且只要當你滿足編譯器的要求時，他們也不在乎。

你真的在問什麼，我想，是如何評論才能使用一些外部工具（如doxygen）。這不是對語言來說很重要的東西，而是對這個工具來說很重要的 - 而且你需要閱讀你的工具的文檔以瞭解它的期望。

來源

2013-11-22 16:12:04 mah

也許@ JaLe29詢問是否有接受的評論標準或約定。這是公司的依賴。 –

謝謝@mah， – JaLe29

@BitFiddlingCodeMonkey我認爲這個問題的目的與外部工具的使用有關，他的例子展示了Java中爲了使用doxygen生成文檔而通常需要的東西。他提到Java，加上評論的doxygen語法是一個很好的提示。 – mah

這是我想評論一個函數定義：

/***************************************************************************** 
* @brief 
* @author 
* @date  
* @return 
* @arg 
* @note  
* 
*****************************************************************************/

來源

2013-11-22 16:11:13

看到有兩種類型的註釋

//單行（簡稱重要信息有關的變量
/* */對於多（主要用於描述）

如何使用它

/* 

This is a Addition function. It takes two variables of int type and yields the addition of it. 

*/ 

int add(int a, int b){ 

int c = 0; // Variable to store result 
return c; 

}

來源

2013-11-22 16:20:13 user2718863

Micr osoft提供了一些指導方針，在http://msdn.microsoft.com/en-us/library/vstudio/ff926074.aspx

放置在單獨一行註釋，而不是在一個代碼行的末尾。
以大寫字母開始註釋文本。
帶句點的結束評論文本。
在註釋分隔符（//）和註釋文本之間插入一個空格，如以下示例所示。

最終，就像@馬說的，如果你是項目中唯一的一個，那沒關係。否則，應事先約定某種約定，並堅持爲了可讀性。

來源

2013-11-22 16:25:34 Trevor

如何正確評論c中的方法？

回答

相關問題