（（意见）使用块范围来组织复杂代码

Question

我正在建立一个Three.js库，发现在{}中将注释放置在注释的下方并嵌套内容，这使得浏览许多代码变得容易。我想就此做法征询其他人的意见，因为我打算更多地在此库的基础上为他人开源。

一些想法，观点和好处

1. 主要原因：我可以根据在块作用域上方看到的注释快速折叠代码。从而使其易于关注我想更改的代码。

2. 我只会在类初始化或非常复杂的方法中使用它。或者更确切地说，是代码使用量大的任何区域，以及适用于这些区域的标签。

3. [我绝不会在没有适当注释的情况下限定其范围。

4. 这有助于我扩展这些不同的部分，特别是如果它们不是可以在合理范围内扩展为新类或对象的东西

5. 我知道代码库的一个常见问题是它们可能会非常压倒一切，尤其是在学习它们时。我认为这种组织代码的方式可以使它变得更加平易近人，并且看起来不那么令人费解。

6. 如果在IDE中具有执行类似此功能的功能，我会很乐意

[使用示例：

Collapsed：

未折叠：] >>

Collapsed：

未折叠

我知道并阅读了其他人针对此方法提出的建议，但是对上下文的讨论并不多。

我也认为这是重构的compliment

，无论它是抽象为函数还是更多类。这似乎很敏捷，并且可以解决代码库中的不确定性，特别是如果您需要以无法限定新类或新方法的方式将问题解决方案整齐地分层放入其自身中时。

我正在建立一个Three.js库，发现在{}中将注释放置在注释的下方并嵌套内容，这使得浏览许多代码变得容易。我想征询其他人的意见，...

Answer 1

我会说最好分解成单独的功能。添加不必要的块可能会给未来的维护人员带来意想不到的后果。许多编辑器支持在注释中使用特殊的语法来帮助代码折叠和导航，而无需更改语法树。