如何在 Linux 上的 IDE 中使用C++代码的文档

How to use the documentation of C++ code inside an IDE on linux?

本文关键字:C++ 代码 文档 Linux 上的 IDE      更新时间:2023-10-16

到目前为止,我尝试了Eclipse,KDevelop和Code::Blocks。

代码::块 (12.11) 似乎根本无法显示文档。

Eclipse (4.3.2) 能够在代码完成期间和悬停时至少显示标准库的文档,但看起来无法生成或添加自定义文档。到目前为止,我已经能够使用DoxygenCPPInfo将xml文档转换为"Java序列化数据"文件,该文件可由libhover使用。但文档仅在悬停时可见,在代码完成时不可见。

KDevelop (4.7) 仅在悬停时显示注释(通常包含文档),并在代码完成时显示大幅缩短的版本。

在编写新代码时,是否有其他 IDE 或其他我可以在代码文档中受益的东西?


DoxygenCPPInfo可以使用eclipse-linuxtools中的以下文件进行编译:

  • 班级信息.java
  • 功能信息.java
  • LibHoverInfo.java
  • 会员信息.java
  • 类型定义信息.java
  • DoxygenCPPInfo.java

xml文档需要放在一个文件中才能与DoxygenCPPInfo一起使用。这可以通过使用带有combine.xslt和index.xml作为输入文件的xsltproc来完成。DoxygenCPPInfo 的最终输出可以放置在 workspace/.metadata/.plugins/org.eclipse.linuxtools.cdt.libhover/CPP/ 中,并将使用该工作区在下一次 eclipse 开始时加载。文档仅在悬停时显示,而不在代码完成时显示。

您希望在一个文件中记录一个函数,并在另一个文件中使用该函数。使用该函数时,您希望引用之前在工具提示中编写的文档,而不必编译第一个文件。这可以在 kdevelopment ide 中轻松完成。我遇到的没有多少 IDE 可以提供如此容易的交叉引用。用于 C 的 Eclipse lib-hover 插件,但它很笨重,我之前在使用它时遇到了麻烦。这是kdevelop手册的链接。

在 kdevelopment 中以 doxygen 样式记录