你遇到过的源代码中最好的注释是什么?
当前回答
我最喜欢的评论是我的一个同性恋朋友说的。他喜欢用VB标记他所有的TODO注释。净,
'TODO: Matt Damon
有时会提供额外的信息,但通常不是这样。
其他回答
下面的代码是在Python模拟教程中看到的。
# This is my rifle.
def rifle(type='hunting'):
print('This is my (%s) rifle.' % type)
# This is my gun.
def gun(type='hand'):
print('This is my (%s) gun.' % type)
# This is for fighting.
def fighting(type='illegal'):
print('This is for (%s) fighting.' % type)
# This is for fun.
def fun(type='gaming'):
print('This is for (%s) fun.' % type)
作者一定是《恶搞之家》的粉丝。^ _ ^
/* Here I sit, Joe broken hearted, came to do some sh*t, but only just started. */
关于一些繁重的正则表达式输入验证。
在一个生成HTML的旧perl脚本中找到:
# I would be _very_ brain farting if I said this code didn't need reviewing.
# It will make babies cry, and hair grow on your back, so please don't use it
看这个:
'On Error Goto Hell.
这在我自己的代码中出现过几次。显然我摸了不止一次。
// TODO: Fix this. Fix what?
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?