很早就想写这样一篇文章。看到 CSDN 的创作活动,就借机总结一下。
需求
什么是笔记?
笔记就是你记录在别的地方,而不是你的脑子里面的东西。也就是说,笔记包含的信息,是曾经进入过你的大脑,而之后又放在别的地方的信息。
为什么要记笔记?
-
备忘
-
做一本好看的充满回忆的温馨的手账
-
整理学习到的信息
-
出版物的原始资料
-
你的知识库
-
…
可见,笔记需求,其实五花八门,每个人对笔记都有不同的需求,当然也需要不同的工具。
本篇,仅面向程序员,说一说编程笔记的写作。
思路
编程笔记的原则
最小依赖原则
您应该采用纯文本格式记录编程笔记,因为代码本身充满了各种符号,代码错一个字符,就没法编译通过;而且,代码本身就是纯文本的,因此,笔者是不依赖任何复杂的格式的,比如 word doc 格式、pdf 格式、和任何笔记软件的格式。编程笔记,就是最原始的纯文本,依赖最小,简单通用,你可以在任何地方,轻松地打开编辑,而不是事先要装一大堆软件
最大复用原则
你的代码笔记,代码要可以再次参考和复用,这个是自然的;同时,你的代码笔记,也要可以输出为排版优雅的格式,便于打印输出,嗯ÿ