首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >使用注释#作为装饰品,以获得更好的视觉辨别能力--这是不是很糟糕的做法?

使用注释#作为装饰品,以获得更好的视觉辨别能力--这是不是很糟糕的做法?
EN

Stack Overflow用户
提问于 2019-03-20 07:16:11
回答 1查看 36关注 0票数 0

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

我的问题是:在数千行代码中,为了更容易区分代码,使用#作为视觉符号是不是一种糟糕的做法?请看下面的示例:

示例1-创建标头

代码语言:javascript
运行
复制
###################################################################
# 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-在代码中装箱

代码语言:javascript
运行
复制
    # 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) #
    ###############################################################

我仍然在整个代码中适当地使用#,以便其他人跟随,但对于重复的内容,我已经创建了巨大的标题(示例1),并将它们向左缩进一次,这样我就可以在编辑器中折叠代码。这在编码社区内是可以的吗?眉头紧锁?或者,没有人真正关心代码是否正常工作,以及在必要时是否有注释?

EN

回答 1

Stack Overflow用户

发布于 2019-03-20 07:28:29

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

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

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/55251318

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档