3

在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# 中那样解析此类信息并因此显示一些提示？

4

2 回答 2

3

查看编码风格和 Doxygen 文档。特别是，您希望看到以下部分：

  • 文件注释
  • 函数和数据结构的注释
  • 编码风格/编码标准
  • 命令说明
于 2013-12-26T07:48:39.413 回答
0

正如卡罗利所说，这只是噪音。在脚本语言中，噪音很受欢迎，因为脚本经常被缩小并使用读者通常不直观的技巧。在 Visual Studio 中，具有自文档化功能似乎是 Microsoft 的“商标”。它主要帮助 Intellisense。就个人而言，我认为滚动浏览代码并阅读 90% 的注释和 10% 的代码是很烦人的。您会注意到 Doxygen 创建的文档往往完全没用。由于它们的自文档性质，您最多会得到一个生成的类名、函数名和“API”列表，但它仅作为参考有用。

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

于 2013-12-26T07:55:54.130 回答