描述一段注释代码的注释格式?

时间:2018-12-05 00:02:12

标签: python-3.x comments sections pep

我经常使用以下格式,其中前导##是描述该块的注释,而#是描述该块中特定部分的注释。

## Create the main widget which holds everything shown in the QMainWindow
# Create and fill its layout
self.main_layout = QtWidgets.QHBoxLayout()
self.main_layout.addWidget(self.nav_view)
self.main_layout.addWidget(self.tab_view)
# Add the layout to the widget
self.main_widget = QtWidgets.QWidget()
self.main_widget.setLayout(self.main_layout)

我之前从未在其他代码中看到过这种情况,我的IDE抱怨这违反了PEP 8,但我认为它看起来不错并且可读性强。我只是想知道是否存在描述此类内容的注释的现有标准?还是只是归结为个人喜好/公司准则?

0 个答案:

没有答案