在做一个已经完成到一定程度的产品时,大部分工作都是从“读代码”开始的,而不是“写代码”。

这个时候,担心“看不懂代码”或者“看不懂代码”的情况并不少见。

在这篇文章中,我试图思考当代码不可读时该怎么做。

我不在乎代码美

首先也是最重要的,代码写的再漂亮,看不懂的也看不懂, 是除法。我觉得这对于刚成为工程师的人和那些容易自责的人来说尤其重要。

不管你的代码多么漂亮,不是你自己写的代码难免难懂事物。

这是因为有些代码(句子)仅仅通过阅读是很难理解的。证据是,没有人能只读一遍社会研究教科书就记住所有内容。 (我想假设这个理论是正确的,所以如果你还记得,请轻轻关闭你的浏览器。)

考虑到这一点,我们可以找到解决方法。

用自己的话表达自己

如果你想了解某事写作比阅读更重要.我有个主意。

如果你想长时间地学习一些东西,你需要把它写下来。如果你真的想理解某件事,你必须用你自己的话把它放回去。备忘录的重点是用你自己的话来写。
Zunk Ahrens。记笔记!用笔记自然地制作自己的输出(日文版)(第 52 页)。Kindle 版。

例如,将您自己的话中的注释添加到代码块中。这是一个简单而有效的策略。

如果没有用于公共方法的 JavaDoc,最好先填写它。当你写了要传达给其他人的内容时,你可以做一个 PR,仅此一项就会在一定程度上有所贡献。

尝试不负责任的“试用重构”

除了用自己的话“写评论”,还可以用自己的话“写代码”。

在“好代码/坏代码的设计学习简介”中,这个尝试重构我正在调用它。

这个【试重构】不是形式上的重构,而是分析逻辑含义和结构的试重构。
好代码/坏代码的设计学习简介 - 如何编写易于维护、不断增长的代码 p.310

假设你不会提交,重写代码。这在代码脏的时候特别有用。

我不在乎我是否犯了一些错误并且我不编写测试代码。尝试使嵌套更小,将一些处理转换为函数,并创建合适的类。

无论如何,我不负责任地进行重构,就好像我要将现有代码染成我自己的代码一样。

当您编写了一些代码时,您将对发生的事情有一个更好的了解。如果你要在那之后真正重构,你应该继续设计。

概括

“阅读代码”的任务经常发生。

根据工程师的不同,大部分工作可能都花在了阅读代码的时间上。

如果你有问题,我建议你尝试“用自己的文字和代码编写”的方法,而不是责怪自己。

参考

评论

本文的主题是“逐个文件读取代码”。

如果你想了解整体代码(了解功能),你应该参考以下内容。


原创声明:本文系作者授权爱码网发表,未经许可,不得转载;

原文地址:https://www.likecs.com/show-308624377.html

相关文章: