仓库源文站点原文


layout: post title: "代码即格式:你用过这些高效工具吗?" categories: 工具 tags: markdown typora puml

author: 张乘辉

我在工作中也用到一些使用起来非常高效的工具,今天以 “代码即格式” 为主题,跟大家介绍下两个高效工具。

文档神器 - Markdown

对于一个程序员来说,记笔记写总结是很经常的事情,对于程序员这类职业的人,他们对编辑器的要求大致如下:

  1. 不需要丰富的格式,因为内容才是重点;
  2. 具备代码高亮格式显示;
  3. 写起来迅速快捷,不拖泥带水,同时拥有丰富的快捷键快速生成对应的文本格式。

因此,富文本并不适合程序员记笔记的要求,因为富文本写起来太累了,比如使用 office word 来写文档,很多时间是花在了格式的调整上面,写毕业论文的时候深有体会,那时我就发誓工作以后如没有特殊要求,绝对不再使用富文本写东西了!

markdown 为此应运而生!它简直就是为程序员量身定做的一款文本编辑器!

我给大家简单介绍下:

markdown 它是一种轻量级的「标记语言」,“标记”我的理解是它可以通过各种符号来代表各种各样的格式,比如#代表一级标题,“语言” 我的理解是指他的语法,千万不要被语法吓跑了,markdwon 的语法非常简单。他可以利用各种标记符号代替复杂的排版工作,使我们专心于码字。

我来说下我平时使用 markdown 的地方:

  1. 写文章

    很多读者可以留意下我的公众号文章的排版,是不是很清晰简洁?千万不要以为我花了很多心思给文章排版,其实我是使用 markdwon 写文章的,由于公众号目前仅支持富文本编辑,因此我会把写好的 md 格式文档通过工具转换成富文本格式,通过复制粘贴到公众号编辑器中,这个过程我不需要做任何排版工作,一气呵成,没有在排版这件事情上面浪费一点时间!

    这里给大家推荐一个转换工具:https://mdnice.com/

  2. 记录日常事项

    我工作中最大的一个习惯就是使用 markdown 记录工作事项,把每天完成的、未完成的内容一点点记录下来,一方面防止事情多的时候会忘记接下来要做的事情,另一方面方便以周或者以月进行工作汇总报告,记录过程通常没有什么格式要求,使用 markdown 可以快速记录,且目录结构清晰。

  3. 其余所有不要求富文本格式的文档输出,我都是通过 markdown 去写的。

这里我向大家推荐一个 markdwon 编辑器神器:typora!在我心里,他是最好用的本地 markdown 编辑器,没有之一!在开发工具里面,它是除了 IDEA、chrome 之外,我使用率最高的一个 APP 了!

给大家讲个小技巧,你们的简历也是可以通过 markdown 来写的哦,最近找我内推的候选人,我都让他们重新再写一份 markdown 格式的简历给我,再通过 typora 转换成 PDF 格式,你就是简历中最靓的仔!

也许很多人在使用 markdown 过程中,抱怨图片不方便粘贴,发给别人总是需要将图片一并打包发给对方,根本原因他们不会使用「图床」这个东西,我特意写了一篇篇文章出来,我真的为你们操碎了心,都说到这份上了,麻烦安排下一键三连(点赞、在看、转发):

使用 PicGo + Gitee 搭建免费图床

值得一提的是,现在各大第三方技术博客平台,基本上都已经支持 markdown 语法了。

制图神器 - PlantUml

公司很多小伙伴都用一款名叫 Visual Paradigm 工具画时序图,为了保持风格一致,我也使用这个工具一段时间,但我发现我自己真的用不来,UI 界面交互复杂,组件拖拽各种反人类设计,后来我还是使用回 PlantUml,它有 IDEA 插件,只需要在 IDEA 安装使用即可:

如上所示,你可以用写代码的方式构建你的时序图,把所有的心思都专注在内容上,你完全不需要理会要怎么去调整格式,按照特定的格式,你把流程相关的内容写下来之后,时序图就完成了。

PlantUml 一共支持以下 UML 图:时序图、用例图、类图、对象图、活动图、组件图、部署图、状态图、定时图。

它的语法是非常容易上手的,基本上看过一遍 demo 就可以上手了!相关教程可以在公众号后台回复关键字「uml」获取教程链接。

代码即格式的核心思想就是让我们在仅限的时间内,通过简单快速的指令,生成对应格式内容,而不用再花费精力在调整格式上面。

好了,以上就是我对以 “代码即格式” 为主题的工具介绍了,欢迎留言补充。

祝大家周末愉快!

我们下期见!