You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何用Doxygen将Python的@property装饰器函数标记为类属性?

解决Doxygen将Python @property标记为类属性的方法
  • 手动添加Doxygen @property命令
    在带@property装饰器的方法的文档字符串里,显式添加@property命令,强制Doxygen将其识别为属性:

    class MyClass:
        @property
        def name(self):
            """
            @property
            这是类的name属性
            """
            return self._name
    
  • 使用@var命令在类级别声明属性
    在类的文档字符串中,用@var命令提前声明属性,并关联到对应的@property方法,这样Doxygen会把它归类到属性区域:

    class MyClass:
        """
        @var name: 这是类的name属性
        """
        @property
        def name(self):
            return self._name
    
  • 升级Doxygen到最新版本
    你提到的2022年相关特性请求,在后续的Doxygen版本(如1.9.5及以后)中已被实现,升级后多数场景下无需额外标记,就能自动将@property识别为类属性。

  • 调整Doxygen配置文件
    确保配置中开启Python相关解析支持:

    EXTRACT_ALL = YES
    PYTHON_DOCSTRING = YES
    

    部分版本需额外设置PYTHON_PROPERTY_SUPPORT = YES(若配置项存在)。

内容的提问来源于stack exchange,提问作者Jan

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.14 03:27:02