让程序员早点下班的《技术写作指南

　　想象一下★■★■★，你打开一个网站，进行登陆，然后被告知：★★■◆◆◆“您的电子邮件/密码不正确。■■”

　　有时你遇到问题去网上搜到了解决办法，那么可以把链接附上，方便回查，以防万一。

　　不管写什么◆★◆★，尽量多用主动语态，因为正常人看到被动语态的句子时都需要在脑子里转成主动语态■★◆★，没必要增加这种处理时间◆◆。

　　相信很多人都遇到过弹出来一行你看不懂的技术提示语的时候，比如■■★◆★★“执行超时“这种■★，让你不知道发生了什么，不知道该怎么做。

　　有网友就表示这条建议非常有用，因为有时他就会忘记自己当时为什么要这么写代码。

　　然后问题就来了，别人不知道这个过程■■，只看到第一行的注释■■◆，会自然以为城市是先按A-Z进行排，然后再反过来从Z排到A。

　　这不，国外一位前端开发就总结了一篇《程序员技术写作指南》，关于如何正确写代码注释■★◆、写PR描述等等。

　　Microcopy指的是用户操作/系统出现失误时，你的网页/APP弹出的提示语。

　　有时★◆★◆，你为了进行一些兼容各种浏览器等目的，可能会在代码中加入一些不常规的写法。这时就一定要注意写注释◆■■■★。

　　代码注释既是写给自己看，也是写给别人看的★◆。尤其是后者，更要写得清楚明了。