时间戳

首页 > 解决方案 > 使用注释#'s 作为装饰以获得更好的视觉识别 - 这是不好的做法吗？

python - 使用注释#'s 作为装饰以获得更好的视觉识别 - 这是不好的做法吗？

问题描述

我正在编写一个非常重复的代码。我正在使用 selenium 启动 webdriver 来推断 PLC 控制器通过其 IP 地址生成的 javascript 数据。该脚本是一个 GUI，允许用户轮询来自 PLC 的数据，包括描述性名称、输入、输出等。

我的问题是：在数千行代码中，为了更容易地区分代码而使用 # 作为视觉对象是不好的做法吗？请看下面的例子：

示例 1 - 创建标题

###################################################################
# List Definition for (AI) with the point name stored in index[0] #     
###################################################################    
        self.ai_ain0_lst = ['Spindle FORCE']
        self.ai_ain1_lst = ['PT-47']
        self.ai_ain2_lst = ['PT-44']
        self.ai_ain3_lst = ['LOAD CELL']
        self.ai_ain4_lst = ['Ring Force Command']
        self.ai_ain5_lst = ['Back Pressure Command']
        self.ai_ain6_lst = ['PT-45']
        self.ai_ain7_lst = ['PT-42']

示例 2 - 在代码中装箱

    # Logo Image ##################################################
    tech_logo = PhotoImage(file=path_to_folder + "tech_logo.png") #
    image_label = Label(self, image=tech_logo)                    #
    image_label.image = tech_logo                                 #
    image_label.grid(row=0, column=4, pady=10, padx=10, sticky=N) #
    ###############################################################

我仍然在整个代码中适当地使用#s 以供其他人跟进，但是对于重复的东西，我一直在创建巨大的标题（示例 1），并将它们向左缩进一次，以便我可以在编辑器中折叠代码。这在编码社区中可以吗？皱眉？或者，只要代码有效并且在必要时有注释，就没有人真正关心？

标签： pythonstandards

解决方案

由于缩进在 python 中是有意义的，所以像这样使用缩进是在自找麻烦。

Python 为您提供包、模块、类、方法和函数，以允许您构建代码。尝试将您的代码重构为这些结构，以便您的代码，而不仅仅是您的文本，易于理解。

推荐阅读