我正在浏览我写的一些旧代码（在大学一年级），发现我以前在代码的各个部分之前都写过注释标题。像这样的东西（这是来自“大富翁”游戏）：
/*Board initialization*/
...code...
/*Player initialization*/
...code...
/*Game logic starts here*/
/*Displaying current situation*/
...code...
/*Executing move*/
...code...
/*Handle special event*/
...code...
/*Commit changes, switch to next player*/
...code...
如果代码非常清晰，这可能是多余的，并且可以说是不必要的，但是当我浏览文件时，即使我几乎不看实际的代码，我也以为我知道发生了什么，这让我感到非常惊讶。在某些情况下，我绝对可以认为这很合适，所以我想知道-您这样做吗？您认为这是个好主意吗？还是太多？
Answers:
这是代码的味道。这说明了什么，而不是为什么。
如果有必要，请将代码拆分为小函数。
/*Board initialization*/，则可能应该在名为的函数中InitializeBoard。如果您的代码结构足够清晰，那么您将不需要注释。
InitializeBoard或的功能InitializePlayer将出现在大多数IDE的功能/模块/类浏览器列表中，而注释则不会。导航更轻松。
我一直都这样。既可以标记代码在做什么，也可以像您所说的那样更重要，以便于扫描和查找代码块。有时候，我也会在注释中写下一个涉及的过程，并在注释下“填写”代码。
之所以这样做，是因为我经常与自己交流意图，或者本质上是为诸如“数据清理从此处开始”之类的内容添加方便的书签。通常在该标题下会简要介绍我在做什么以及为什么这样做的逻辑。
我喜欢冗余。如果由于某种原因而丢失了我的实验室笔记本，或者不得不重新阅读我几年前编写的代码，那么我不喜欢将自己正在做的事情以及为什么要做的事情汇总在一起。如果代码中至少包含某些逻辑，则其文档已足够使我至少可以再次使用它。
我认为我对它的偏爱部分是因为我的编程相当一部分是统计性的，因此有些重复。尽管可能有几段代码需要搜索一个有用的命名函数，但是我可能有数十种相当相似的用法，例如通用线性模型函数。能够找出其中哪些是“结果对选择A与选择B或C的敏感程度”，还有哪些是有用的。这通常会因标题而加快。