摘要:
本文介绍了PyCharm IDE中代码标签的定义、类型和使用方法。
原文链接:
FreakStudio-全网最适合入门的面向对象编程教程:05 类和对象的Python实现-PyCharm代码标签(一个帮你提升coding效率的小技巧)
往期推荐:
可能是全网最适合入门的面向对象编程教程:Python实现-嵌入式爱好者必看!
全网最适合入门的面向对象编程教程:00 面向对象设计方法导论
全网最适合入门的面向对象编程教程:01 面向对象编程的基本概念
全网最适合入门的面向对象编程教程:02 类和对象的Python实现-使用Python创建类
全网最适合入门的面向对象编程教程:03 类和对象的Python实现-为自定义类添加属性
全网最适合入门的面向对象编程教程:04 类和对象的 Python 实现-为自定义类添加方法
更多精彩内容可看:
文档和代码获取
可访问如下链接进行对文档下载:
https://github.com/leezisheng/Doc
本文档主要介绍如何使用 Python 进行面向对象编程,需要读者对 Python 语法和单片机开发具有基本了解。相比其他讲解 Python 面向对象编程的博客或书籍而言,本文档更加详细、侧重于嵌入式上位机应用,以上位机和下位机的常见串口数据收发、数据处理、动态图绘制等为应用实例,同时使用 Sourcetrail代码软件对代码进行可视化阅读便于读者理解。
相关示例代码获取链接如下:
https://github.com/leezisheng/Python-OOP-Demo
正文
上一篇在类方法的注释中,你可能已经发现每个方法下面一行都有:
#TODO:打开串口方法待完成
在Pycharm中,它长这样:
你可能在别的代码中看过类似的标识,如FIXME、NOTE、UNDONE等,这些是注释中的标签(tag),有时也被称作“代码标签(codetag)”或“标记(token)”。它们在编写代码中属于非正式使用的记号,但在项目开发中,能够能让代码编写者在代码中起到提示、索引和快速定位的作用。在大多数 IDE 或文本编辑器当中,以如上所述标签作为开头的注释,也会有特殊的语法高亮。代码标签实际上就是一种特殊类型的注释,这些注释在编辑器中突出显示、已编入索引并在 TODO 工具窗口中列出。
其中,TODO表示即将着手编写的代码,说明需要完成的任务或实现的功能。
TODO格式如下:
# TODO(name): Need implementation
在Pycharm中,我们可以在下方导航栏中看到所有TODO标识的函数:
除了TODO外,还有FIXME标签,表示需要修复的bug。通过使用代码标签,在对包含多个文件的项目进行编码时,我们可以快速找到待完成的方法/函数以及待修复的bug。