开发人员说明，不仅仅是“其他人”

使用开发人员说明保持自己的进度和时间效率

随着我在这段编码之旅中走得更远，我发现自己有意识地回顾过去，承认我已经走了多远。很多时候，我们没有意识到我们实际上取得了多少进步，因为每天的变化都太微妙了。但是，如果我们退后一步，看看整体，这一切都会带来巨大的转变。花时间定期给自己一点点安慰是一种很好的自我激励。

几个月前我开始学习编码时，我真的没有任何实践经验。除了在 Pascal 上的一堂课和在高中时和朋友一起上 Geocities 网站（这也可能是在不同的一生中），我从零开始。所以回顾我在 JavaScript 和 React 中学到的东西，让我印象深刻。

我喜欢让自己在学校的课程中挣扎，因为我发现如果我自己解决问题而不是寻找其他人完成的代码，我会获得更强大、更持久的知识。但是，在我制定了可行的解决方案后，我想看看有哪些效率可用。

我最近实现自己的解决方案的一个问题是开发人员说明。我倾向于在马拉松比赛中编写代码。我开始了，在不知不觉中，我错过了饭菜，而且快到早上了。当我只有不到一小时的时间时，我并不特别喜欢编写代码。

但是一个小时是很多时间。我开始思考，为什么我只有不到一个小时的时间不喜欢编码？答案是要花很长时间才能弄清楚我在哪里停下来，我在做什么，哪些组件在哪里传递了哪些道具，以及我打算编写的下一段代码是什么。当我全部热身并准备开始时，我已经花费了太多时间来让新的编码值得我剩下的时间。在我家，时间很宝贵。

因此，我将以下几个步骤合并到我的编码中，这些步骤使我可以快速轻松地从中断的地方开始。

第 1 步：保持准确和更新的组件层次结构

当学习在 React 中编写只有三个或四个组件的单页应用程序时，在头脑中弄清楚组件层次结构是什么相对简单。但是随着应用程序变得越来越复杂，并且您要管理的组件越来越多，在您的脑海中保持正确的组件层次结构很快变得更加困难。

无论是在您的自述文件中还是在您的顶级组件中，请帮自己一个忙，并始终包含您的组件层次结构的一些表示，即使对于小型应用程序也是如此。

它可以像这样简单：

或者更复杂：

当然，您可以移动组件并通过读取导入来确定哪些组件相互依赖，但是在尝试找出如何构建新组件或在哪里停放或传递道具时，在一个地方直观地查看它可以节省时间。

第 2 步：在组件中添加更多描述性注释

我开始为自己添加更多开发人员注释的主要原因是因为我必须花费太多时间来试图记住我使用这个或那个函数的去向，或者哪个进程正在提供什么。虽然描述性地命名您的函数和变量应该是我们都遵循的标准，但不可避免地可能在您的应用程序中存在多个“handleDelete”或“handleLike”函数，这会使事情变得混乱。即使你对每个函数和变量都进行了超级个性化，命名约定也只能这么长，而且还不如普通的老开发者笔记。

在这里，我们有一小段代码相对容易弄清楚应该发生的事情：

当组件呈现时，它应该将 CurrentUser 重置为空字符串。然后，当用户在表单中输入他们的姓名时，信息就会被捕获。当他们提交信息时，他们的用户名被设置，他们被重定向到主页。

但是想象一下场景（在紧凑的屏幕中不太容易描述），您的函数更加分散或依赖于更多变量或执行更复杂的工作。如果你只写了一些额外的描述性词，你会不会感激？像这样：

第 3 步：维护待办事项列表

当我草拟一个新的应用程序时，我会列出我想要合并的功能：发表评论、点赞帖子、删除帖子、编辑帖子、添加图像等。一旦我有了一个好的起点，我就会优先考虑它按我想要处理它们的顺序列出。当我完成任务时，我将它们从列表中删除，或者当我想到其他任务时，我将它们添加到列表中。同样，您可以将此列表保留在任何您喜欢的位置。在预部署时，我只是将其保留在我的组件层次结构图下方。