如何在 Xcode 9.3 中显示 C++ 代码文档？

Question

我在 Xcode 中开发基于 C++ 的软件，并且希望（至少）像我为 Swift 或 objc 开发代码文档一样方便。

示例：

std::string myString("hello");
if (myString.empty()) {
    // do something
}

如果我想确切地知道 .empty() 的作用，我想按住 Option 键并单击该函数，然后获取文档覆盖信息，例如来自http://en.cppreference.com/w/cpp/string/basic_string/empty，与 objc 和 Swift.

完全一样

这怎么可能？

当前输出如下所示：

Answer 1

这是为您定制的class。您可以像这样添加您的评论 - 在 header 我这样做

 /**
     * Method name: name
     * Description: returns name
     * Parameters: none
     */

这是我做的一个示例 -

#ifndef test_hpp
#define test_hpp

#include <iostream>
#include <string>

class myclass{
private:
    std::string name_;

public:

    myclass(std::string);
    /**
     * Method name: name
     * Description: returns name
     * Parameters: none
     */
    std::string name();
};

#endif /* test_hpp */

Answer 2

我会支持 Deb 的回答，但我也看了一会儿。

Markdown in Xcode 在 Xcode 9 中有些脆弱。

它适用于函数声明：

还有标注：

文档注释似乎对函数声明很有效，但对函数中的代码行根本不起作用。

Answer 3

你不能。根据 Apple's Xcode release notes，截至 Xcode 8.3

3rd party docset support is now deprecated and will no longer be supported in a future release of Xcode. (30584489)

还有其他文档浏览器，例如 Dash，可让您安装自己的文档。但这并没有给你你所希望的。

我已验证将 C++.docset 添加到 ~/Library/Developer/Shared/Documentation 中不起作用。（可能是早期 Xcode 留下的目录）事实上，完全删除此目录不会影响 Xcode 9.x 正确显示默认文档。

如何在 Xcode 9.3 中显示 C++ 代码文档？

How can I show C++ code documentation in Xcode 9.3?

c++

xcode

code-documentation

c++11

xcode9