突发奇想之:源码及文档,文档包括源码---xml格式的源码,文档源码合并;注释文档化,文档代码化;
2023-09-14 08:59:54 时间
目前源码和文档一般都是分开的,我在想为什么 源码不就是最好的文档么?
但是一般源码都是文本text的,格式化需要人为统一规范,所以源码中的文档在现实中不是那么的易于实践。
而且 源码 不能包括图片、附件、示例代码等资源,这个又是一个难点。
后来我突发奇想,为什么不能把xml作为一种合二为一的文档呢?
xml可被IDE识别,解析其中 包括 <code lang=cpp> 的标签中的文本为 代码。编译也使用这部分。
其他的标签 全部都是文档。而且可以在code 代码中 再分割,添加文档部分。
而文档部分,可以直接发布为纯文档格式的html文件,或pdf文件。
其实 doxygen 就是此类的工具,只是是基于文本的。而且是单独的工具。
如果IDE 支持也好。但是还是无法解决图片 附件 二进制的东西。
这个其实可以使用 BASE64 后放入xml,然后解析 在IDE中显示。
IDE 就好像在一个浏览器中编写代码。
这个实现起来挺难的。因为好用的IDE 都比较少。(我指开源 or 免费的)
目前最好用的C++IDE还是 Visual Studio 。而且2013 社区版 也免费了。
相关文章
- 【说站】【全开源商城小程序源码】ThinkPHP 5.1+带后台商城源码程序+带详细安装使用文档
- 一款完整的多用户微信公众平台开发源码,带文档免费分享「建议收藏」
- CTO来分享:如何让技术人员写好开发文档?
- 图解浏览器引用本地硬盘上的JS文档
- Word VBA技术:提取文档中的所有批注并在新文档中放置其详细信息
- 【Android Gradle 插件】Android Plugin DSL Reference 文档介绍 ( 1.2 ~ 3.4 版本文档地址 | 4.1 ~ 7.1 版本文档地址 )
- 【Android Gradle 插件】将自定义 Gradle 插件上传到自建 Maven 仓库 ① ( Maven 仓库上传源码上传源码设置 | 自定义源码打包任务 | 自定义文档打包任务 )
- AI时代来临,如何把握住文档处理及数据分析的机遇
- 《Hyperledger Fabric官方文档》之关键概念翻译邀请
- Redis: 官方文档指南(redis官方文档)
- 讲解neo4j中文文档,使用手册(neo4j中文使用手册)
- 编写项目文档时要问自己的 5 个问题
- 的文档搜索无果:寻找MSSQL文档的困境(找不到mssql)
- Linux使用GVFS轻松跨设备管理文档(linux gvfs)
- ORACLE数据库官方文档下载指南(ORACLE下载文档表格)
- ORACLE下载文档复制一步到位(ORACLE下载文档复制)
- asp.net下用Aspose.Wordsfor.NET动态生成word文档中的数据表格的方法
- C#实现EXCEL数据到TXT文档的转换