Формат комментариев, которые описывают раздел комментария кода? - PullRequest
Новая
       30

Формат комментариев, которые описывают раздел комментария кода?

0 голосов
/ 05 декабря 2018

Я часто использую формат ниже, где ведущий ## - это комментарий, который описывает блок, а # - комментарии, которые описывают определенные части в блоке.

## 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, но я думаю, что это выглядит красиво и читабельно.Мне просто интересно, существует ли существующий стандарт для комментариев, описывающих подобные разделы?Или это просто сводится к личным предпочтениям / руководящим принципам компании?

...