如何在ANSI C中編寫文檔註釋？

我找不到如何在C中寫評論。我的意思是我知道//和/* */，我的意思是我在哪裏可以找到好的做法？就像我有一個函數一樣，我如何編寫@param variable is the value bla bla，就像它在Java中完成的一樣？如何在ANSI C中編寫文檔註釋？

這是否有任何標準？或者我可以像我在Java中那樣做嗎？

來源

2012-01-17 bb2

實際上，你甚至不能在ANSI C中使用''''。只有從C99開始，它們才允許'// //'。（儘管GCC允許它作爲擴展）。 – Mysticial 2012-01-17 05:10:03

C中只支持'/ * * /'。''是C++中的一個附加項。 – 2012-01-17 05:12:29

術語「ANSI C」通常是指1989 ANSI標準所描述的語言，但嚴格來說這是不正確的。 1990年，ISO頒佈了相同的標準（包含一些新的介紹性材料和重新編號的部分），ANSI採用了它。 1999年，ISO發佈了新的C標準，ANSI也採用了該標準，使1989/1990標準正式過時。在2011年末，ISO發佈了另一個新的C標準，ANSI也採用了該標準。除第一個標準外，C標準最初由ISO發佈，而不是ANSI - 最好每年參考標準。 – 2012-01-17 05:16:39

有許多不同的標準，如果要生成文檔，請嘗試doxygen

來源

2012-01-17 05:10:15

有沒有標準，按照標準的貴公司的授權。
從項目創建文檔的流行方式是使用Doxygen。

來源

2012-01-17 05:10:15

一個選項是使用doxygen格式的書寫評論 - 這有額外的好處是能夠爲您的代碼生成HTML /乳膠和其他種類的文檔。

來源

2012-01-17 05:12:00

您可以使用javadoc標準，然後使用明白javadoc生成文檔的doxygen。

在doxygen中，我建議使用選項JAVADOC_AUTOBRIEF設置爲YES。如果JAVADOC_AUTOBRIEF標記設置爲YES，那麼doxygen會將Javadoc樣式註釋的第一行（直到第一個點）解釋爲簡短描述。一類定義

實施例：

/** 
* A brief description. A more elaborate class description 
* @param bool somebool a boolean argument. 
* @see Test() 
* @return The test results 
*/

（一些更多的例子in the doxygen manual）

安裝是非常簡單的，有一個GUI和可用一個不錯的圖形可視化：

apt-get install doxygen doxygen-gui graphviz

運行gui調用doxywizard並使用Wizard設置，只有JAVADOC_AUTOBRIEF必須在「Expert」設置中設置英格斯。

來源

2015-12-22 05:52:54 rubo77

一個很好的例子。 – Drew 2015-12-22 06:06:36

如何在ANSI C中編寫文檔註釋？

回答

相關問題