文件缓存到浏览器后下载延迟_将文件推迟到最后的情况

文件缓存到浏览器后下载延迟

我有一个坏习惯，那就是尽可能长的时间不编写文档。 在提交请求之前，这通常是我的最后一项任务。 每当我浏览成百上千行代码编写文档时，我都会想：“下一次，我将继续这样做。” 下次我编写新功能时，可能会把文档留到最后。

不过，尽管如此糟糕，但我已经意识到，在编写文档之前，等到代码完成后，它会有一些好处：

1. 减少浪费的精力：在理想的情况下，开始编码后，您的API和要求不会改变。 但是，这种情况多久发生一次？ 如果您需要更改代码并且已经对其进行了文档记录，那么现在您必须浪费时间来更新文档。
2. 强制自我检查：您是否曾经编写过一段代码，然后再查看一下，发现自己可以做得更好？ 在回顾代码以进行记录时，您不得不重新评估已完成的所有工作； 编码和记录之间的额外时间有时可以为您提供重构所需的视角。
3. 捕获无效代码：没有什么比删除文档更让我想要删除不必要的代码了。 在记录方法之前，我可能会检查以确保它实际上仍在使用。
4. 一致性：一次执行所有操作时，我发现在文档中使用了更一致的术语。 我进入一个区域，找到我认为有效的语言，并在整个过程中坚持使用。

一堂课记录了……还有更多……

当然，有一些原因没有人真正鼓励这种行为：

1. 太糟糕了：如果您不喜欢文档（我绝对不喜欢），那么一次编写所有文档确实很痛苦。 每次编写方法时都要编写文档，这很烦人。 为数十种方法编写文档是残酷的。
2. 褪色的内存：当您最终编写文档时，您可能已经忘记了代码的功能或做出某些决定的原因。 另一方面，这很好地表明了无论如何都应该重构代码。
3. h，算了吧：面对这项艰巨的任务，只是跳过文档或将其放在待办事项列表中以供日后使用是非常诱人的。 有时候，你可能能够摆脱这一点，但你真的从来没有应 。

因此，我不完全建议您等到最后一分钟编写文档。 我只是说它有一些好处。 或者，也许我真的只是想证明自己的行为是正确的……

参考：在Jerry on Java博客上，由我们的JCG合作伙伴 Jerry Orr 推迟发布文档的案例 。

翻译自: https://www.javacodegeeks.com/2013/03/a-case-for-putting-off-documentation-until-the-end.html

文件缓存到浏览器后下载延迟