你遇到过的源代码中最好的注释是什么?
当前回答
这实际上是我在实现原型转换为实际代码时所做的:
// Abandon all hope you who needs to debug this
是的,有比我聪明的人在之后重构了代码(它必须有一个好的结局)。
其他回答
不是代码注释,而是SVN在同一个文件上提交注释:
第一次提交(在测试人员返回结果后,再进行数十次提交):
Squashed some IPR mod bugs. The were big and juicy ones, too.
2日提交:
Squashed some more mod bugs. Those are some nasty bugs, them mod bugs...
3rd:
Squashed some more mod bugs. They are like cockroaches: they'll live through a nuclear war.
4th:
Squashed some more John bugs. They too are like cockroaches: they appear anywhere John goes. Wait. That doesn't sound right.
5:
Same John bug. It didn't die, just played 'possum.
是的,我厌倦了"修复bug"
为什么你不应该将你的软件开发外包的一个经典案例:
public class Contact
{
//...
/// <summary>
/// Gets or sets the name of the first.
/// </summary>
/// <value>The name of the first.</value>
public string FirstName
{
get { return _firstName; }
set { _firstName = value; }
}
}
试着在谷歌代码搜索中输入你最喜欢的脏话,它会消磨掉许多无聊的时间。以下是我最喜欢的例子:
/* These magic numbers are fucking stupid. */
/* Dear free software world, do you NOW see we are fucking
things up?! This is insane! */
/* We will NOT put a fucking timestamp in the header here. Every
time you put it back, I will come in and take it out again. */
# However, this only works if there are MULTIPLE checkboxes!
# The fucking JS DOM *changes* based on one or multiple boxes!?!?!
# Damn damn damn I hate the JavaScript DOM so damn much!!!!!!
/* TODO: this is obviously not right ... this whole fucking module
sucks anyway */
/* FIXME: please god, when will the hurting stop? Thus function is so
fucking broken it's not even funny. */
我个人最喜欢的
# code below replaces code above - any problems?
# yeah, it doesn't fucking work.
这实际上是我在实现原型转换为实际代码时所做的:
// Abandon all hope you who needs to debug this
是的,有比我聪明的人在之后重构了代码(它必须有一个好的结局)。
在一个项目中,我们有一个依赖ppwlib,当时它的FreeBSD端口有点糟糕,所以我不得不从源代码手动构建它。但它并没有立即起作用,我不得不研究代码;有一些复杂的类层次结构,部分代码是由宏生成的,其父类声明以它们开始
// The root of all evil ... umm classes
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?