根据Doxygen's manual，有一些标准可以正确评论用C编写的程序。不幸的是，记录程序的方式似乎没有很好地标准化（即GNU编码标准）。
如果我同意函数的最常见标题是：
/**
* 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编程标准准确定义了如何根据研究编写这样的分隔符（不那么麻烦，眼睛不那么累，社区最常用，......）？
答案 0 :(得分：0)
我认为这取决于偏好和可读性。
例如，我喜欢使用以下内容：
/*----------------------
| Function
| Author:
| Dependencies:
----------------------*/
/*----------------------
| Section
-----------------------*/
//Comments in sections
为了便于阅读，我结合以下规则使用它。
我发现阻止引用的最简单方法是突出显示代码，然后使用键盘快捷键“Ctrl + Shift + /”来注释掉该块。适用于大多数编辑。
希望有所帮助。