是否有任何标准如何在c ++中编写函数或变量的描述

Question

在c＃中你可以有这样的描述：

    /// <summary>
    /// Return true if channel contains the given user name
    /// </summary>
    /// <param name="user"></param>
    /// <returns></returns>
    public bool ContainsUser(string user)
    { ...

在c ++中是否标准化或广泛使用？有些IDE能够解析这类信息，就像Visual Studio在c＃中所做的那样，并因此显示一些提示吗？

Answer 1

结帐Coding Style and Doxygen Documentation。特别是，您希望看到以下部分：

• 文件评论
• 功能和数据结构的评论
• 编码样式/编码标准
• 命令说明

Answer 2

就像Karoly所说，这只是噪音。在脚本语言中，噪声很受欢迎，因为脚本经常被缩小并使用通常对读者不直观的技巧。在Visual Studio中，具有自我记录功能的Microsoft似乎是“商标”。它主要帮助Intellisense。就个人而言，我认为滚动代码并阅读90％的评论和10％的代码是非常恼人的。您会注意到Doxygen创建的文档往往是完全无用的。由于它们具有自我记录性质，因此您最多可以获得一个生成的类名，函数名和“API”列表，但它仅作为参考有用。

保留Doxygen文档（如果您愿意）作为参考，但通过以实用方式评论您的代码，保持较低的信噪比并进行手工记录来提供实际文档。