python注释】 python 对变量添加注释

2022-03-15 16:03发布

vs里面可以做到写个注释后选中变量就能看到这个注释,python里能不能达到同样的效果?

vs里面可以做到写个注释后选中变量就能看到这个注释,python里能不能达到同样的效果?

6条回答
三岁奶猫
2022-03-24 09:41

Python添加注释很简单,在文件开头加入一个#即可。因为前面有个#,代码并没有被执行

第二行代码加入了#,所以第一行代码被执行,第三行被执行,第二行没有被执行

那么,我们为什么要在代码中添加注释呢?代码中的注释又没有被运行,看起来没有任何意义啊?

首先,作为使用者,是完全不知道注释的存在的,因为注释压根就不被运行,和使用者没有任何的关系。使用者只要运行这个程序就可以了

但注释对开发者而言就意义重大了,如果代码很长,写的又比较复杂,而你的代码需要给另外一个人继续开发或者维护,那么注释就很重要了。如果没有注释,对接手的人而言是很痛苦的,但如果有注释,他们就可以凭借着注释快速的理解这些代码了

同时,如果注释写的好,就可以大量减少文档的存在,可以通过注释去维护代码的文档

但是,写了注释,并不意味着代码可以乱写,代码还是要有规范的,如果代码写的规范、易懂,再加上合理的注释,将大大减少后续开发及维护的成本和时间


一周热门 更多>