了解命名空间文档

Question

我正在努力理解 doxygen 如何与 Python 中的命名空间一起工作。默认情况下会生成名称为“filename”的命名空间，即 temp.py。我还可以使用 \package 或 \namespace 命令声明新的命名空间。

但是，我不明白的是为什么下面的类（或任何其他定义）总是出现在 temp 命名空间下？

请帮助我了解命名空间命令在 doxygen 中的工作原理。

如果您知道 doxygen 中如何以及为何使用 /namespace pr /package 命令，您可以绕过下面的示例并直接回答。

#filename = temp.py
##\mainpage Main Page Title
#\brief main page title comments  \n




## class class_demo1 \n
#  the class declared below \n
class class_demo1:
        pass

from new_package import *

现在，我添加了一个名为 \new_package 的新命名空间，添加在 temp.py 文件中，

##\package new_package
#new namespace comments \n

我还创建了一个名为 \new_package.py 的文件，并在其中添加了以下行：

def demo_fun:
    pass

class demo_class:
    pass

在生成的文档中，我在命名空间 \temp 下得到 \class_demo1。 但是，新的命名空间 \new_package.py 不显示在下面声明的类和 def 它。

Answer 1

如果在 new_package.temp 模块中定义了 Demo 类，则将它放入 new_package 命名空间中：

new_package/
├── __init__.py
│   #   from .temp import Demo
└── temp.py
    #   class Demo:
    #       pass

在这种情况下，doxygen 只需要反映以下关系：已经在代码中了。