coding-style - 您见过的最无用的评论是什么？

Question

As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center提供指导。




9年前关闭。

Locked. This question and its answers are locked，因为该问题是题外话，但具有历史意义。它目前不接受新的答案或互动。








大家都知道，注释我们的代码是编码风格的重要组成部分，它可以使我们的代码对接下来出现的其他人甚至我们自己在6个月左右的时间内都可以理解。

但是，有时发表评论并不会减少芥末酱。我不是在讲明显的 Jest 或发自内心的frustraton，我在谈论的似乎是试图解释的评论，但这样做的效果很差，以至于可能根本不存在。 太短的注释， 太含糊的的注释，或者 的注释只是简单的。

作为一个传奇故事，您能否分享一下您看到的只是 而不是糟糕的的东西，如果不是很明显，请显示它所指的代码并指出问题所在？应该将放到那里去什么 ？

也可以看看:

When NOT to comment your code

How do you like your comments? (Best Practices)

What is the best comment in source code you have ever encountered?

最佳答案

只是典型的Comp Sci 101类型的注释:

$i = 0; //set i to 0

$i++; //use sneaky trick to add 1 to i!

if ($i==$j) { // I made sure to use == rather than = here to avoid a bug

诸如此类的事情。

关于coding-style - 您见过的最无用的评论是什么？ ，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/143429/

上一篇：macos - 在 Mac OSX 上获取蓝牙耳机的电池电量

下一篇：language-agnostic - Code-Golf:模数除法

相关文章：

关于静态方法的 Java 编码约定

php - 多个 PHP 标签

python - 有没有一种标准的方法来归因于/引用 python 代码？

mysql - 网站评论系统的数据库结构

c - 是否应该为所有整数类型提供函数变体？

java - 关于正确关闭/提交数据库事务和执行查询的问题

C++ 代码风格 : SHA2 algorithm

c# - VS2010 : Automatically insert date and initials to single line comments

Emacs 中类似 Eclipse 的行注释

java - 如果我在 JavaDocs 中使用 <br> 会有人杀了我吗？

©2023 IT工具网  联系我们

Answer 1

只是典型的Comp Sci 101类型的注释:

$i = 0; //set i to 0

$i++; //use sneaky trick to add 1 to i!

if ($i==$j) { // I made sure to use == rather than = here to avoid a bug

诸如此类的事情。