在写文章的时候我经常会遇到这么一个需求,我想要跟大家说明某一行代码需要改动成另外一行代码。
比如我这里有一段代码:
FROM python:3.6WORKDIR /appCOPY . .RUN pip install -r requirements.txtVOLUME [“/app/proxypool/crawlers/private”]CMD [“supervisord”, “-c”, “supervisord.conf”]
仅仅作为示例,这里行号我也没标,行数也有可能很多行,比如上百行。
比如我就想告诉大家,我想把:
RUN pip install -r requirements.txt
改成:
RUN pip install -r requirements.txt -i https://pypi.douban.com/simple
这一行。
看,我已经说完了。
为了说这件事,我需要打好几行字,我得把原来的代码打上,然后说「改成」,然后再把新代码打上。
麻烦吧?
有没有什么更好的表述方式呢?
有。
看这里:
-RUN pip install -r requirements.txt+RUN pip install -r requirements.txt -i https://pypi.douban.com/simple
是不是很直观?
红色代表删减,绿色代表增加。
经常 Code Review 的朋友一定倍感亲切。
那这个怎么实现的呢?其实这就是用了 Markdown 高亮的一种写法,只需要把语言改成 diff 就好了。
原语言如下:
这里为了防止 Markdown 解析冲突,我就用图片了。
反正就是语言标注改成 diff,然后需要删除的前面加个减号,需要增加的加个加号就行了。