你遇到过的源代码中最好的注释是什么?
当前回答
在初始化链表时:
last = first; /* Biblical reference */
简洁而滑稽。
其他回答
//说明:!!待办事项
从技术上讲,这不是一个评论,而是在凌晨2点左右编写的代码:
consent = False
... 该变量永远不会再次使用,并且出现在套接字的监听循环的开始。
/// <summary>
/// The possible outcomes of an update operation (save or delete)
/// </summary>
public enum UpdateResult
{
/// <summary>
/// Updated successfully
/// </summary>
Success = 0,
/// <summary>
/// Updated successfully
/// </summary>
Failed = 1
}
今天刚加了这个:
// Hardcoded this for time sake ... will make andrew fix later :)
这是我最喜欢的评论。
/// I intend to do this as shittily as possible because there are many better products that will totally blow this out of the water
/// and we don't have them so whatever
在后面的文件中,我们有更多的乐趣
/// sidestep a bug in WCF (that we can't send types across)
/// or, depending on how you look at, this issue is a Feature
稍后再讲
if( where == null)//be nice
推荐文章
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?
- 你遇到过的源代码中最好的注释是什么?