在Python中使用不同级别的注释

Question

我经常发现自己编写的代码含有不同级别的注释，例如

# Comment about "Doing A"
...

## Comment about "Doing part 1 of A"
...

## Comment about "Doing part 2 of A"
...

# Comment about "Doing B"
...

现在我有一种倾向认为这被认为是错误的，但是在阅读过去的代码时，它总是对我有意义并且有所帮助。由于最近使用pylint来检查我的代码，它会按照我预期的那样抱怨，我不应该使用多个#。

有什么方法可以帮助我保持不同评论级别的可读性，而不实际使用它们？

Answer 1

它主要是个人选择，但这就是我所做的。

对于主要部分，请使用这样的块注释：

########################################################################
#                               Doing A                                #
########################################################################

对于小节，我使用像这样的单行注释

#-------------------------Doing part 1 of A----------------------------#