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

To document class members in Python for Doxygen you have to annotate them with two number-signs / hash-tags (##).

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

But PEP8 code checkers (e.g. pycodestyle) take this as an error (E266).

Of course I can set the specific error to ignore. But his is a workaround not a solution.

The question is if there is any other solution for Doxygen to annotate class members without violating PEP8?



Solution 1:[1]

@albert and @Mathy answered this in the comments.

Using """! instead of ## would help.

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

Sources

This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.

Source: Stack Overflow

Solution Source
Solution 1