你遇到过的源代码中最好的注释是什么?
当前回答
为什么你不应该将你的软件开发外包的一个经典案例:
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; }
}
}
其他回答
// TODO: Implement this function!
// fix for groupid > 9
// if groupid ever gets to 100 everything will break (again)
if (groupid < 10) {
groupid = "0" + groupid;
}
从http://www.madore.org/ ~大卫/电脑/ callcc.html:
/* Yow! DEMONS are flying through my NOSE! */
// Holy moses! I've never seen anything so ridiculous in all my life.
// Why do we need to query the AlarmIDs table twice.
// Please tell me sir; I would really like to know.
// This like all the other services have been mangled
// to the point where they are nearly impossible to determine what kind of side affects might occur.
// I am making the smallest changes I can to this code.
// The GetAlarmId method gets the alarm id from the AlarmIDs table.
// Novel idea, why didn't we query for the values be get below all in the same place.
// This should be changed, but right now it will have to remain as is due to time constraints.
// This like all other services really don't do anything fantastically hard, but after the original coders got
// done with them; they are difficult to work with and have an acceptable comfort level.
public GetRandomNumber()
{
// Chosen by a fairly rolen dice
return 12;
}
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?