0

我越来越坚持记录我的所有代码并向我的团队中的用户和其他工程师展示我在哪里找到给定的信息，或者我在哪里找到了特定的代码部分。

我希望能够完成的是创建指向我的代码行或文件（Verilog/SystemVerilog、VHDL、C/C++ 和 RTL 源）的链接，但真正找到或想出一个解决方案来用任何语言这样做会对我有益。

这将通过 Word 文档、PDF 文件完成，我不介意设置、使用 LaTeX 等，但我想找到一种方法。本质上，我想单击一个参考，在其中我指定了行或文件，并且该文件在编辑器中显示给读者。

所有文档都将放置在所有使用该文件的用户都可以看到必要文件的地方，我的偏好是能够在 Linux 中执行此操作。

4

1 回答 1

1

您可以使用 doxygen 生成 html 文档。我用它从我的 VHDL 源代码中生成 html 文档。

如果你想引用外部文档，doxygen 确实支持外部链接。我从未尝试过这样做，但文档表明它们是自动提取的。

http://www.doxygen.nl/manual/autolink.html

一个例子是（取自并扩展自： http: //www.doxygen.nl/manual/docblocks.html 

-------------------------------------------------------
--! @file
--! @brief 2:1 Mux using with-select
-------------------------------------------------------

library ieee;
use ieee.std_logic_1164.all;

--! Mux entity brief description

--! Detailed description of this mux
--! Documentation can be found at http://the_documentation.html
entity mux_using_with is
port (
    ...
);
end entity;

运行 doxygen 后，您将获得一组超链接文档，包括自动层次结构图，以及对您的外部文档的引用。

我发现层次图很有用，不用担心任何外部绘制的图片，因为它似乎是重复工作。

编辑：我应该补充一点，doxygen 是独立于语言的，因此可以在您建议的所有代码类型中使用。您必须稍微摆弄一下配置文件才能获得最适合您的输出。

于 2013-06-02T09:47:04.530 回答