代码之家 › 专栏 › 技术社区 › stk

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

code-documentation xcode9 c++11 xcode c++

stk · 技术社区 · 8 年前

我在Xcode中开发基于C++的软件,希望(至少)在代码文档方面具有与为Swift或objc开发时一样的便利性。

示例:

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

如果我想知道到底是什么 .empty() 是的,我想选择单击该功能并获取文档覆盖,其中包含以下信息:。 http://en.cppreference.com/w/cpp/string/basic_string/empty ,与objc和Swift完全相同。

这怎么可能?

电流输出如下所示:

3 回复 | 直到 8 年前

christopherdrum 8 年前

你不能。根据 Apple's Xcode release notes ,自Xcode 8.3起

第三方docset支持现已弃用,不再 Xcode的未来版本中支持。(30584489)

还有其他文档浏览器,如 Dash 允许您安装自己的文档。但这并没有给你你所希望的。

我已经验证了添加一个C++。文档设置为 ~/Library/Developer/Shared/Documentation 不起作用。(可能是早期Xcode遗留下来的目录)事实上,完全删除此目录不会影响Xcode 9。无法正确显示默认文档。

Deb S 8 年前

这是您的自定义类。你可以像这样添加评论-在标题中我这样做

 /**
     * 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 */