目前源码和文档一般都是分开的,我在想为什么 源码不就是最好的文档么?

但是一般源码都是文本text的,格式化需要人为统一规范,所以源码中的文档在现实中不是那么的易于实践。

而且 源码 不能包括图片、附件、示例代码等资源,这个又是一个难点。

后来我突发奇想,为什么不能把xml作为一种合二为一的文档呢?

xml可被IDE识别,解析其中 包括 <code lang=cpp> 的标签中的文本为 代码。编译也使用这部分。

其他的标签 全部都是文档。而且可以在code 代码中 再分割,添加文档部分。

而文档部分,可以直接发布为纯文档格式的html文件,或pdf文件。

其实 doxygen 就是此类的工具,只是是基于文本的。而且是单独的工具。

 

如果IDE 支持也好。但是还是无法解决图片 附件 二进制的东西。

这个其实可以使用 BASE64 后放入xml,然后解析 在IDE中显示。

IDE 就好像在一个浏览器中编写代码。

这个实现起来挺难的。因为好用的IDE 都比较少。(我指开源 or 免费的)

目前最好用的C++IDE还是 Visual Studio 。而且2013 社区版 也免费了。

 

相关文章:

  • 2022-02-24
  • 2022-12-23
  • 2021-07-12
  • 2021-11-23
  • 2021-12-03
  • 2022-02-14
  • 2021-08-15
  • 2021-08-13
猜你喜欢
  • 2021-10-29
  • 2022-03-03
  • 2022-01-04
  • 2021-06-27
  • 2022-12-23
  • 2021-07-09
  • 2021-12-09
相关资源
相似解决方案