入门Web开发者咨询:简单文本/信息/注释文件应选何种格式?
针对你现在用VS Code做学习笔记、记录开发相关信息的场景,推荐以下几种常用的非可执行文件格式:
Markdown(.md)
绝对是开发者圈最流行的选择,不管是项目README、学习笔记还是技术手册都能用。语法简单易上手,支持标题、列表、加粗、代码块、引用等格式,完全能替代你现在用注释分区的方式——直接用多级标题、列表就能把内容划分得清清楚楚。VS Code原生支持实时预览,还能装Markdown All in One、Markdown Preview Enhanced这类插件,支持导出PDF、HTML,甚至能做思维导图,非常适合整理结构化的学习内容。纯文本(.txt)
最轻量化的选项,没有任何格式限制,所有编辑器都能打开,适合快速记录零散的快捷键、命令片段这类内容。优点是极简、通用,缺点是没法做复杂的格式分区,适合临时记东西或者内容非常零散的场景。reStructuredText(.rst)
在Python生态里用得比较多,常用来生成结构化的技术文档(比如用Sphinx工具构建项目文档)。语法比Markdown更严谨,适合需要严格格式规范的技术手册,VS Code有对应的插件支持语法高亮和预览。AsciiDoc(.adoc)
功能比Markdown更丰富,支持更细致的排版和文档结构,适合写复杂的长篇技术文档,比如产品手册、详细的开发指南。VS Code也有专门的插件支持编辑和预览,适合对文档格式要求更高的场景。Org Mode(.org)
原本是Emacs里的模式,现在VS Code有插件支持,它能把笔记、待办事项、文档整合在一起,结构非常清晰,适合做长期维护的学习笔记或者个人知识库,还能支持任务追踪、导出多种格式。
如果你只是日常整理学习笔记、记录开发相关的零散信息,首推Markdown,既满足格式需求,又能和主流开发工具、代码托管平台完美兼容。
内容的提问来源于stack exchange,提问作者Bodyload

