C中的註釋部分和註釋塊C

根據Doxygen's manual，有一些標準可以正確評論用C編寫的程序。不幸的是，記錄程序的方式似乎沒有很好的標準化（即GNU編碼標準）。C中的註釋部分和註釋塊C

如果我同意，功能最常見的標題是：

/** 
* Brief description. 
* 
* @param a first parameter 
* @return if any return value 
* 
* Detailed description 
**/

不幸的是這種解決方案是很煩人的，當我需要快速地註釋代碼塊用/* ... */。這就是爲什麼我更喜歡使用//的原因，它不與/*..*/互動。那麼編寫函數註釋頭文件的最佳方式是什麼？今天的大多數標準都是基於傳統的C89標準。

我的問題的第二點與部分評論有關。我經常在我的代碼的不同部分有我想明確區分的內容。例如：

/** 
* @file foo.c 
* 
* StackOverflow Example 
**/ 

/************************************************************* 
* Includes 
************************************************************/ 
#include <stdio.h> 
... 

/************************************************************* 
* Prototypes 
************************************************************/ 
void foo(); 
void bar(); 
...

有大量用於任何C編程標準，精確定義瞭如何基於一個研究上寫這種隔板的（不太麻煩，對眼睛，最常用的由社區不易疲勞，...）？

來源

2014-11-06 nowox

據我知道如何分開部分是不是定義你可以做你想做的事情！ – Rizier123 2014-11-06 13:49:31

@ Rizier123這也是我的想法，但在編程的情況下，我恨我什麼時候可以做我想做的事情。如果有任何標準，我願意堅持下去。 – nowox 2014-11-06 13:53:33

然後設置你自己的標準！（製作你自己的編碼指南） – Rizier123 2014-11-06 13:54:38

我認爲這歸結於偏好和可讀性。

例如我喜歡使用以下內容：

/*---------------------- 
| Function 
| Author: 
| Dependencies: 
----------------------*/ 


/*---------------------- 
| Section 
-----------------------*/ 

//Comments in sections

我結合使用這與可讀性以下規則。

2線的剖面標題之前返回/註釋部分標題後
1線返回/註釋

我已經發現阻斷報價最簡單的方法是突出的代碼，然後向使用鍵盤快捷鍵'Ctrl + Shift + /'來註釋該塊。適用於大多數編輯。

希望有所幫助。

來源

2014-11-06 14:00:27 Paul

C中的註釋部分和註釋塊C

回答

相關問題