你遇到过的源代码中最好的注释是什么?
当前回答
对上帝诚实:
// This is crap code but it's 3 a.m. and I need to get this working.
其他回答
我最喜欢的评论是我的一个同性恋朋友说的。他喜欢用VB标记他所有的TODO注释。净,
'TODO: Matt Damon
有时会提供额外的信息,但通常不是这样。
大约1997年,Netscape网络浏览器的UNIX风格的源代码:
/* HP-UX sucks wet farts from dead pigeons' asses */
不幸的是,在Moz开源之前,这些珍珠被移除了……
/// <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
}
为什么你不应该将你的软件开发外包的一个经典案例:
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; }
}
}
// Iced odnako
bool Iced{get;set;}