软件开发

使用Markdown快速书写技术文档

背景介绍

在设计和开发公司某项目的过程中,通过与同事交谈,了解到目前使用Word作为主要的技术文档制作工具,有以下使用难点

  1. 排版困难,比如:标题、有序列表的调整,都很繁琐,效率低
  2. 格式方面,比如:给代码加语法高亮,Word支持很差。如果截图贴到文档里,易用性、可编辑性都比较差

针对上[……]

继续阅读

Java代码注释TODO FIXME XXX的意义

特殊注释

TODO

表示需要实现,但目前还未实现的功能

如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。

XXX

勉强可以工作,但是性能差等原因

如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能[……]

继续阅读