博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Python 编程规范 —— TODO 注释(结合 PyCharm)
阅读量:4916 次
发布时间:2019-06-11

本文共 484 字,大约阅读时间需要 1 分钟。

编程是代码和注释的统一;

TODO 自然表示需要做而未做的一些待完成的事项,有助于事后的检索,以及对整体项目做进一步的修改迭代。

# TODO(kl@gmail.com): Use a "*" here for string repetition.# TODO(Zeke) Change this to use relations.

最好在注释中包含一个截止日期(“2009年11月解决”)或等待一个特定事件的发生(“等到所有的客户都可以处理XML请求就移除这些代码”)。

一些基本要求和规范:

  • TODO注释应该在所有开头处包含”TODO”字符串,
  • 紧跟着是用括号括起来的你的名字, email地址或其它标识符.
  • 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的TODO格式,
  • 这样添加注释的人就可以搜索到(并可以按需提供更多细节).

在 PyCharm 中,使用 Alt + 6 快捷键,可快速调出项目中的全部 TODO 注释;

转载于:https://www.cnblogs.com/mtcnn/p/9422038.html

你可能感兴趣的文章
html meta标签属性用法集合
查看>>
AVL 平衡二叉树
查看>>
关于DSP仿真软件CCS中断点和探针的简单理解
查看>>
实验吧-杂项-异性相吸(异或加密)
查看>>
留言板
查看>>
数据库行转列操作
查看>>
爬虫学习资源
查看>>
svg格式的中国地图轮廓图
查看>>
Find All Numbers Disappeared in an Array
查看>>
时间序列挖掘-预测算法-三次指数平滑法(Holt-Winters)
查看>>
Web.Config文件配置之连接默认错误页
查看>>
[实用]19个Web开发者必备速查表(多图)
查看>>
操作系统实验一:并发程序设计
查看>>
Java常用的系统类
查看>>
XPO to Database Connectivity: Mastering Fork Etiquett
查看>>
ADO实现单条记录的刷新《转》
查看>>
python列表和循环判断
查看>>
Spring各jar包的作用(转载)
查看>>
Windows10 +Ubuntu 18.04双系统安装详细教程
查看>>
ecmall 别人做好的商城
查看>>