来自早读君：

项目中最近上了一个功能就是对html页面做压缩去空格处理，导致很多单行注释的都失效，从而报错。当看到今天这篇文章分享的注释也是很好玩。

正文从这开始～

现在我明白了，我在编程方面的很多做法都是古怪的、不入流的，不过，对我而言，多多少少是有帮助的。我的网站比大部分网站，肯定存在更多的问题，但是我交付的速度快了不少。你不都懂的。

我从来无法正确学到的一件事，就是注释我的代码。人们通常注释代码的方式如下：

上面的代码是从 PHP The RightWay 直接摘录的。我纠结的地方在于，代码缩进越深，代码就变得越发难以理解。如果你深入两个 foreach 循环，你该如何知道这部分代码起始何处？问题在于注释无法以某种方式来分割代码。你看不到某段代码的结尾。

你可以使用函数把代码简化为一行，这解决了很多问题。但是把每个小段代码弄成函数，也会减慢你的速度。

是否有一个折衷方案呢？

我受 HTML 的启发，其代码常常非常清晰，因为你能看到一个标签从哪儿开始、到哪儿结束。一目了然，下面是我相应做出的注释风格：

我在 PHP、JavaScript、Obj-C、甚至Shell 脚本里使用这种注释风格，实际上对于我快速地搞清楚要编辑某个文件的哪个部分、以及其功能，让我节省了大量时间。

更有意思的是，如果你在用 Sublime Text，那么你还能折叠标签之间的整个代码，比如：

这可能违背了在 Hacker News 游荡的、留着大胡子的委员会编写的编码法则的宏大指导。不过还行，我没有留胡子。

来自早读君：

上周在规范项目的目录结构，当项目接手的人迭代好几个版本之后，没有一个统一的规范是很浪费时间的，特别是服务端合并代码的时候。

大家约定好目录，做好合并的规则，这个项目跑起来就非常顺畅了。一定程度上也节省了非常多的时间。

这也是早读君第一次去关注到这块领域的。羞射～～

顺道推荐一个mac下通过tree生成项目目录结构的命令行：

ps：这个也是在编写项目规范文档的时候用到了。

长按图片识别图中二维码