Doxygen 的双哈希标签/数字符号 (##) 不符合 PEP8 (E266)

Question

要在 Python 中为 Doxygen 记录 class 成员，您必须用两个数字符号/哈希标签 (##) 对它们进行注释。

class Foo:
  def __init__(self):
    ## This is a public member
    self.bar = 7

但是 PEP8 代码检查器（例如 pycodestyle）将此视为错误 (E266)。

当然我可以设置具体的错误忽略。但他是一种解决方法而不是解决方案。

问题是是否有任何其他解决方案可以让 Doxygen 在不违反 PEP8 的情况下注释 class 成员？

Answer 1

@albert 和@Mathy 在评论中回答了这个问题。

使用 """! 而不是 ## 会有所帮助。

class Foo:
  def __init__(self):
    """! This is a public member"""
    self.bar = 7

Doxygen's double hash-tags / number-signs (##) are not PEP8 conform (E266)