代码注释可以不写，但文档记录一定不能欠缺。 ——题记
人生一路，诸事遭逢缠身，免不了要写一写、记一记。生活习惯变化，纸笔不一定随身有，但手机或电脑一定是随行的。一般人，想要用文档记录东西的时候，首先想到的就是打开 Word 或 WPS，创建一个 DOCX 文档；使用经验的限制，使得一般人以为记录东西的文档只有 DOCX 文档。适用于普通人的习惯，却不适合开发者，或者说程序员群体。
身为程序员，就应该对 DOCX 文档的缺点了如指掌，知道这个文档的可迁移性，比 TXT 格式的文档差很多。DOCX 这个编码方式自成一体的非纯文本格式文档，它的打开，需要依赖装有Word 或 WPS、以及其他支持解码 DOCX 文档的专用编辑器，而不是像纯文本格式文档那样，普通记事本可以打开、浏览器可以打开，一众 IDE 工具可以打开，就连终端也能够打开。
所以，程序员记录经验或知识的文档，必须用纯文本文档，也只有这样，才可以做到随时随地任意设备都能打开。最基础的 TXT 文档，在排版方面不是很方便，也不支持标题、加粗等常用文本样式，所以，它们并不是程序员记录东西的最优选择。程序员，是一群拥有编写程序代码能力的群体，所以，大可以用同样带有编程特性的 MarkDown 文档和 HTML 文档。
MarkDown 文档，简书社区当前也支持，语法比正儿八经的编程语言少很多，上手难度不大，只需记住常用的格式标注符号即可。MarkDown 文档，可以通过将 TXT 文档的文件后缀改成 md 的形式创建。MarkDown 文档的内容，既可以当作普通的纯文本文档显示，也能以具有一定排版格式的富文本样式渲染。MarkDown 文档有其优点，也有其缺点，其缺点就是排版样式固定不支持自定义、字体颜色和背景颜色常常需要通过加装样式插件来实现。
相比之下，HTML 文档在文本样式的个性化方面，功能尤为强悍。很多经验不丰富的程序员，会呆板地认为 HTML 文档是用来设计和实现网页的，并不是什么笔记文档。实则不然。HTML 是为网页而生，但从来就没有规定 HTML 只能用于网页设计、不能用于做笔记。其实吧，作为程序员，无论自己是开发还是测试，也无论自己是前端开发还是后端开发，用 HTML 文档做笔记的好处，在于能让自己始终保持对 HTML 的手感，甚至在记录东西的过程中，做到将 HTML 的功能进一步发觉。
用 HTML 记录文档，不仅可以利用 CSS 去实现各种好看的排版样式，还能通过 Javascript 让自己的笔记动起来，要比 MarkDown 文档炫酷很多，更比 DOCX 文档强大很多。实际上，在国内外的软件大厂中，早就有项目团队用 HTML 文档来创作开发者指导手册，这也侧面证明用 HTML 记录东西的可行性。并且，相比 MarkDown 的样式渲染，HTML 文档的样式渲染更具备可迁移性。
MarkDown 文档要像不被当作普通纯文本文档解读，就需要安装支持解析和渲染 MarkDown 文档的编辑器，而 HTML 文档的渲染只要有浏览器就行，而浏览器早就是手机电脑的标配、出厂自带，所以，一份用 HTML 文档记录的笔记，可以在手机、电脑等智能设备上原模原样的渲染出来，除非你可以选择用普通的纯文本编辑器打开。
此外，如果是和本身具备 Doc 功能的编程语言相关的内容，如 Java 学习笔记，我更建议直接记录在源代码脚本上，这样也可以省去另建文档、贴代码的功夫，后续回顾代码的时候，也比较一清二楚。至于其他编程语言相关的学习笔记，要么用 MarkDown 记录，要么用 HTML 记录；当然了，后一种方式是我推荐的，但为了省时间和省事，也不是不可以使用 MarkDown 文档记录。
使用 MarkDown 文档记录也好，用 HTML 文档记录也罢，乃至用 JavaDoc 记录都行，它们有个共同的特点，就是可以很便利进行云存储、多端同步，具体而言，就是随着项目一起 git 到代码托管平台，这可不算是薅开源设施的羊毛，用 npm 转存《庆余年》盗版资源的人才是。自己的记录文档，以公开仓库的形式存放后，是有助于其他人学习和巩固相关编程语言的，所以，是在为开源生态添砖加瓦。
最后，特别地敬告所有程序员，千万不要用 DOCX 文档来记录经验和知识，更不要将这些记录文档打包存放到网盘上，不然，后面不仅下载可能存在困难，内容读取也可能存在麻烦；反过来，一定要学会用 MarkDown 文档、HTML 文档记录，并养成将记录文档随项目一起托管到代码平台上的习惯，对于代码托管平台，大家可以逐步迁移到 Gitee 上面了，毕竟这是国内的，访问速度会比 GitHub 快很多。
网友评论