如何写评论

嗨，我有50页的代码，我应该写评论... 你可以告诉我最好的方法。我的意思是我需要你给我写的......样品，的意见应该几乎涵盖一切（类，构造函数，属性，方法，事件，函数）如何写评论

2010-01-01 Tony

-1：做我的家庭作业。你能提供一个更小，更紧凑的片段吗？你能问一些更具体的问题吗？ “选择任何部分和表演”是相当粗鲁的，你不觉得吗？ – 2010-01-01 13:41:49

不要删除答案提到的代码 – 2010-01-01 14:36:38

嘿，代码在哪里？ – 2010-01-01 14:41:09

不评论什么是显而易见的像

//The width of the line is 2 
lineWidth = 2;

或

//Clones the snapshot 
tempDraw = (Bitmap)snapshot.Clone();

有可能是一个好主意，解释为何一定的代码行是存在的。例如，解释为什么

panel1.Invalidate();

需要失效。

其基本思想是：在注释中添加额外的信息并将其用于解释，不要创建冗余和重复。

编辑：

您可能还需要解释为什么在工具栏上的每个项目必须是未选中这里：

private void toolStripButton1_Click(object sender, EventArgs e) 
{ 
    foreach (ToolStripButton btn in toolStrip1.Items) 
    { 
     btn.Checked = false; 
    } 
... 
}

，因为不是从按钮被点击该事件处理程序的名称明显以了解为什么所有按钮都未被选中。

一个很好的注释是这样的：

private void toolStripButton1_Click(object sender, EventArgs e) 
{ 
    //Deselect all previously applied filters because the user clicked "disable all", 
    //which removes the effects of all filters and we want to show this the the user 
    foreach (ToolStripButton btn in toolStrip1.Items) 
    { 
     btn.Checked = false; 
    } 
... 
}

来源

2010-01-01 13:36:00

在我看来，最好将控件重命名为toolStripButtonDeselectAllFilters，而不是将控件命名得如此糟糕，以至于每次引用它时都需要注释来解释它的作用。 – 2010-01-01 14:28:19

马克，当然重构将是最好的选择。但为了“修复”它只使用评论，我想这是最合适的解决方案。 – 2010-01-01 14:40:29

不，不要把时间花在那些无论重要还是必须重做的事情上。什么也不做，或重构。 – 2010-01-01 15:10:31