如何正确地在语句中添加长注释

问题描述 投票:0回答:1

我正在尝试在我的项目中关注PEP-8。例如。有一些语句应该有一个长注释(因此现在行长超过79个字符):

    fields_to_display = ['id', 'order_item']  # set here a list of fields to display when something happens somewhere

PEP-8中,我们读:

内联注释是与语句在同一行上的注释。

所以我想我应该使用嵌入式注释。如果是这样,我应该如何使其适合79 characters restriction

python python-3.x pep8 pep
1个回答
0
投票

是,您应该使所有行都适合79 characters restriction。像这样:

79 chars

但是,如果需要详细说明,则可以在多行中断开注释。

类似地,您可以检查是否可以在方法定义下放置""" Multi-line comment used here for my code. """ 以便在其中放置说明,而不是在每一行中都放置说明。

© www.soinside.com 2019 - 2024. All rights reserved.