封面图
截止今天为止，手头上的东西终于忙个差不多了，可以好好休息一下了。
文档和注释的重要性
作为一名程序员，一项很重要的技能是整理好项目所需要的文档。为什么这么说，因为文档是项目开发的线索，通过我们的梳理，将脑子里的想法整理成有迹可循的文档，在开发起来思路会比较清晰，可以提升开发效率，一定程度上也可以降低开发中出现错误的概率。
通常我们都遇到过这种问题，接到一个项目，然后产品经理或者项目负责人告诉我们有哪些功能要开发，然后我们问他：有需求文档么？
如果有，那么接下来的事情就很简单，我们只需要按照需求文档中要求的功能进行开发即可。如果没有文档，那么我们可能会花费一些时间去对这些需求进行梳理，虽然感觉上没什么，但是潜在的时间成本以及其他边际成本其实都被忽略掉了。
同样，在团队中，我们也需要注意团队整体的技术能力。通常情况下团队成员的技术能力都是不太一样的，所以，类似代码规范文档,git流程操作规范文档，组件开发规范文档，组件相关的文档，需求文档，技术设计文档以及相关的时序图等等就显得非常有必要了。
因为如果有这些基本的文档之后，新入职的同学就可以根据这些文档来熟悉相关的项目，可以减少沟通上的时间成本，一定程度上提高工作上的效率，毕竟时间就是金钱。
同时，我们在代码的开发过程中，其实需要尽可能的去写一些注释。为什么呢？有些人写代码不喜欢写注释，可能觉得我的代码写的非常好，变量定义的非常语意化，别人一看就知道是什么。
其实未必，因为代码所展现的只是自己当时的一些想法，一旦由别人来接手之后，或者转去开发别的业务，一段时间之后自己也未必知道自己当时是怎么想的，为什么代码要这样写，于是又的排查半天时间，才能弄明白当时的业务逻辑，尤其是业务逻辑非常复杂的时候。
所以，我们在写代码的时候尽量的去写一些注释，不必写的面面俱到，只需要代码所表达的基本含义解释清楚即可。
这样，虽然代码中可能多了几行注释，但是后期的可维护性会提高不少。
相反，如果我们的代码中只有代码没有注释，那么想象一下下一个接手你业务的开发者，此时他正在你写的一个有2000行代码的js文件中看的焦头烂额，心里在想：怎么一行注释都没有？这代码写的真高级！我反手就是一个赞👍。
一说到开发项目，或者一提到前端，我们总是会提到什么组件化,工程化，规范化，可维护性等等这些个听起来高大上的名词。
其实反过来想一想，这么高大上的东西，在实施的过程当中，我们是不是应该从最开始就把基本的注释和文档整理一下呢。
万丈高楼平地起，千里之行始于足下，切勿好高骛远，从最基础的地方做起即可。
