作为一名开发人员，我是如何记笔记的

最近，我意识到做好笔记的重要性。

我承认我这样做过不止一次。

我以前对记笔记的态度是“如果我记不住，那它肯定不重要”。

哎呀。

这或许在艺术院校行得通，因为那里草图和概念图很常见。但是，随着我深入软件工程师领域，记住具体的流程就变得困难得多。

首先，需要回忆的不仅仅是概念本身，而是如何回忆。

你用的是 Ruby 还是 JavaScript？虽然从数组中随机获取元素的思路在两种语言中可能相同，但语法会有所不同。输出结果应该是什么格式？或者，是否需要传入参数？

当我编写的代码与我以前做过的代码类似，但我却想不起来我是怎么写出来的，这时我脑海中就会浮现出这些想法。

如果我能把大脑中目前被《大力神》每首歌的歌词占据的记忆空间全部释放出来，也许我就能记住所有的事情了，但现在，我还是坚持做好笔记吧。

以下方法对我有用。

字面上来说，就是在代码中写注释。

我可能不是世界上唯一一个认为未来的用户会记得自己代码功能的开发者。短期内这或许没错，但长期来看（几天、几周、几小时等等），情况就完全不同了。

为了解决这个问题，我会在注释中向自己解释每一行代码的作用。

这里有一个示例，使用一种方法，每次运行时都会随机生成一个新的十六进制颜色。

def createColor
# Lists all possible integers that can be use in a valid hex code
  hexadecimalIntegers = ["0","1","2","3","4","5","6","7","8","9","a","b","c","d","e","f"] 

# Randomly get 6 items from the hexadecimalIntegers array, then join them together at each character
color = hexadecimalIntegers.sample(6).join("")

# Puts hex color
  "Your new hex color is ##{color}" 
end

写注释的时候，我喜欢思考如何向别人解释我的代码。我还可以更进一步，添加注释解释为什么我用 `.`.sample代替 ` .rand.`

手写笔记

我承认，我自己也曾犹豫过是否要走这条路。我用子弹笔记来记录待办事项，但既然在电子文档之间复制粘贴这么容易，手动编写代码就显得很傻了。

有研究表明，纸笔笔记比打字笔记更有效，所以我决定试一试。

刚开始接触Ruby的类时，我感觉头晕目眩。这是一个全新的概念，涉及很多方面。我想在学习更高级的内容之前，确保自己理解了核心概念。

重温 Ruby 课程时，我会重新阅读课程资料并做笔记。任何我发现自己容易忘记的关键概念——比如实例变量——我都会记下来。和我在代码片段旁边添加的注释类似，我会用通俗易懂的语言解释这个函数在整体代码中的作用。

手写笔记迫使我保持​​笔记简洁明了、重点突出。这种笔记方式，再加上我的行内注释，在重构代码时非常有帮助，这也引出了我的下一个观点。

经常审查和重构

你是否曾经解决过某个问题，然后感觉自己不知道自己究竟做了什么？

或许这是因为想在短时间内学习大量知识而导致的副作用。但我意识到，在学习新概念之前，最好还是花时间回顾一下之前写的代码、笔记和注释。

这就需要用到重构了。

重构对我来说是一个新概念，但我认为它是在保持现有代码功能的同时对其进行改进。

通常情况下，我的代码内联注释足以说明问题，让我知道这段代码最初是为了解决什么问题而编写的。

然后我可以参考我的手写笔记（其中涵盖了更广泛的概念），看看我可以在哪些方面进行改进。

例如，是否有需要澄清的变量名？是否有可以删除的冗余代码？我的代码是否应该考虑到某些特殊情况？

总之，努力做好笔记可以彻底改变你的学习之旅。

虽然手写笔记加上内联代码注释对我来说很有效，但重要的是使用最适合你的笔记格式——手写、打字、录音。

学习新概念时，你通常采用哪种笔记方法？

照片由 Kelly Sikkema 拍摄，来自 Unsplash

原文发表于我的博客：https://shannoncrabill.com/blog/taking-notes-as-a-developer/