•  11-07-2019
  •  | 
  •  

题

我一直有点用的DevExpress的CodeRush和重构！临这个星期，我拿起了评注插件为您键入的代码，会自动生成注释。

我不想去探讨如何好它挑选出基本意义的工作（相当不错的，其实），但它的默认实现确实提出了一个问题。

默认情况下，键入}字符关闭一个块将导致插件添加如下所示的注释... 

using(MyType myType = new MyType())
{
    myType.doWork();
} // using

（即添加到它被打开结束花标签评论。）

虽然我可以看到，有实例，其中此行为可能是非常有用的，我觉得，由此得到的代码看起来很邋遢的所有附加注释。

我想知道其他人;公司采取这种评论的了。不只是从学术角度来看，但如果我得到一个很好的一些关于他们的负面评论，我可以决定是否造成他们在我的同事或带他们出去。

有帮助吗？

解决方案

我觉得这样的评论是没有用的，当然，除非该代码是可怕的。随着代码正确的格式是不难看出其中块开始并且其中块结束，因为通常这些块是缩进的。

编辑： 如果过程是如此之大，是不是显而易见的是由一支柱关闭哪一个代码块，则应该已经描述反正过程更具描述性的评价和这些评论也只是杂波。

其他提示

我发现genrates从代码注释，而没用插件的想法。如果能够由机器来推断那么它也可以被任何人阅读它推断。的评论是极有可能是完全冗余的。

我觉得那些右括号注释是凌乱的，它给出了更好的，如果个人要到IDE直接提供的信息。

IMO所描述代码的作用已经告诉你每一个评论是不必要的。

如果你真的有代码块是这么长时间，你必须滚动很多看到有开始你做错了事，可考虑分割代码了。

很坏很坏的注释风格 - 它引入了代码库修的开销

。

我已经发现谁在C-语法代码}s的痕迹是混乱称为前VB程序员，但在这种情况下真正的解决办法是重构代码，以防止深度嵌套和过长的功能和/或代码块

也许有用，如果使用块延伸在IDE中的页面，但后来你有其他的问题不用担心。在这种情况下我适当缩进和，突出匹配的括号当我选择一个的IDE获得通过。

我给它一个大拇指朝下一般，但与潜在使用时无法避免的长块，否则。

有时你会得到非常大的代码块，还是有很多嵌套块的收起来。我有时用这种风格在这样的情况下，但绝对不是所有的时间。我不限制它的代码之一：HTML可以从这个风格的“关闭评论”大大受益：

<div id="content">
    <div id="columns">
        <div class="column">

            <!-- .. snip a lot of lines .. -->

        </div> <!-- .column -->
    </div> <!-- #columns -->
</div> <!-- #content -->

这样的意见只是对有用的代码很长的块，你有很多嵌套块。但认为这不应该是摆在首位的许多嵌套块和长方法要求重构的情况。 所以，我不喜欢这个所有的，因为读者很明显可以看到它是哪一个代码块。

我觉得更有用的比意见将是IDE接口功能，不仅彰显对匹配的括号，也显示在工具提示中的openining线，因此，如果您将鼠标悬停在你的例子在大括号它会拿出“使用（的MyType =的myType新的MyType（））” 中的工具提示。

这将使您容易地使大型的功能复杂的嵌套括号的意义，而不提供恒定视觉混乱。

我总觉得它有用记住这个...

清除，以及编写的代码将提供足够的什么的代码是做一个称职的程序员解释把它捡起来。

评论应该留在代码解释的为什么的代码是干什么的！

在换句话说，使用注释来帮助你的代码的读者理解算法，或者是什么代码是应该的实现的，不是的如何的它实现它！

您可能想看看这篇文章由杰夫·阿特伍德。

不这样做，它只是增加了噪音，如果使用所有的地方，再说适当的缩进应该解决的可读性问题。

我会保持它关闭。我只看到一个点在使用此当你在同一个地方（或长或短块）结束多块 - 我已经用他们自己在某些情况下，像这些。然而，如果它们被用于这将是更好手动添加它们，在精心挑选的地方，而不是一些自动化工具添加它们。

如果你必须要考虑某一类型的注释是否是可用或不是，它是最有可能是后者。

注释是用于说明某些代码块或在其整个的实体，以放松对理解;不使格式更易于阅读。

有一个插件总是符合这种行为是既肥胖和难看。

我同意有更好的方法来描述一个代码正在做什么。

如果你有由单个信息注释前面码长身体状 //修复工作项目，你可以采取的代码和重构它作为自己的方法。然后使用作为新方法的名称，FixWorkItem（）的注释。这样做，这是一个快速的方法，使你的代码更自我记录，甚至可能会揭示一些设计特点，你之前没有注意到。

请留意像作为潜在refactors，其可以自动地由IDE处理单行注释。该文档本身代码甚至比写的最好的独立意见更好，当然除了说明意图时的感觉。

许可以下： CC-BY-SA 和 归因
不隶属于 StackOverflow
scroll top