使用评论#作为更好的视觉辨别力的装饰 - 这是一种不好的做法吗? [关闭]

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

我正在研究一个非常重复的代码。我正在使用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),并将它们向左缩进一次,以便我可以在编辑器中折叠代码。这在编码社区中是否可以?淹死了?或者,只要代码有效并且在必要时发表评论,没有人真正关心?

python standards
1个回答
1
投票

因为缩进在python中是有意义的,所以你要通过使用这样的缩进来解决问题。

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

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