Python 编程规范 —— TODO 注释（结合 PyCharm）

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

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 注释；

Working with TODO in PyCharm
Python风格规范

Python 编程规范 —— TODO 注释（结合 PyCharm）相关推荐

Python 编码规范 TODO注释
如: # TODO(Dontla): 提取filenames中数字# TODO(Dontla): 重新构建并写入文件快捷键:alt+6 ,快速找出所有待办TODO 参考文章1:Python编码规范- ...
python使用符号#表示单行注释-【经济金融及Python应用讲义】Python编程规范之注释...
原标题:[经济金融及Python应用讲义]Python编程规范之注释来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么 ...
python使用符号表示单行注释-Python编程规范之注释
来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了. 可以发现,在编写代码的过程中,我们 ...
python代码注释规范-Python编程规范之注释
来源:计量经济学服务中心经济金融及Python应用讲义一.注释 1.为什么需要注释如果代码的编写者在这里添加了备注说明,那么读者很快就能理解该段代码的含义了. 可以发现,在编写代码的过程中,我们 ...
简明 Python 编程规范
本文最初发表于赖勇浩(恋花蝶)的博客:http://blog.csdn.net/lanphaday,如蒙转载,必须保留全文完整,未经本人同意,不得用于商业目的.51Testing软件测试网 Lfh g ...
简明 Python 编程规范v2
赖勇浩(http://laiyonghao.com) 注:之前发布一篇<简明 Python 编程规范>(见:http://blog.csdn.net/lanphaday/article/d ...
简单叙述python的编程规范_简明 Python 编程规范
注:之前发布一篇<简明 Python 编程规范>(见:http://blog.csdn.net/lanphaday/article/details/2834883),本是我给当时所在的公司 ...
简述python程序的书写规范_简明的 Python 编程规范
简明的 Python 编程规范使用编码规范编写程序,不仅可以别人让后面维护的人更方便,同时也方便自己检查程序.以下是百分网小编精心为大家整理的简明的 Python 编程规范,希望对大家编写程序有所帮 ...
python编程用什么软件？Pycharm好不好？
python编程需要用什么软件?学python编写代码的时候,可以使用的软件有很多,大致分为这几类:编辑器.解释器.终端.包管理.脚本引擎等.但在这其中,我们必不可少的软件就是PyCharm,这是py ...

Python 编程规范 —— TODO 注释（结合 PyCharm）

Python 编程规范 —— TODO 注释（结合 PyCharm）相关推荐

最新文章

热门文章