你遇到过的源代码中最好的注释是什么?
当前回答
我们有一个小组项目,使用最小-最大树创建一个Connect 4 AI。在我们的move-scoring函数中,我们让它为棋盘计算分数,在这段代码之上有这样的注释:
// This is kind of almost useless
但还有更好的。我们的导师给了我们一些他制作的粗糙AI的示例代码,并留下了很好的评论:
// We also add/subtract some points based on what's going on, on the bottom
// row. (I think this is retarded, but apparently when I coded this up
// back in 1999 I didn't.)
其他回答
/* Here I sit, Joe broken hearted, came to do some sh*t, but only just started. */
关于一些繁重的正则表达式输入验证。
//open lid
//take sh!t
//close lid
文件打开,数据转储,文件关闭…
options.BatchSize = 300; //Madness? THIS IS SPARTA!
简单但有效的注释,在一些不太安全的c++代码之前
// yikes
为什么你不应该将你的软件开发外包的一个经典案例:
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; }
}
}
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?