一.doxygen应用场景: doxygen可以用来管理目前主流的编程语言的注释而形成文档系统.(包括C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran等).doxygen官网地址(http://www.doxygen.nl/)近来大部分时间花在api接口的维护上面,其中比较重要的一个环节就是你写的接口如何让调用者一目了然的理解用法.不管是内部无线服务端与客户端之间的配合,还是对外开放的API接口,都一样.花了几…

VuePress 相关链接 完整的Vue组件代码以及完整的文档,仅适用于个人参考学习: 文档预览地址:预览链接 使用VuePress编辑文档的代码访问:组件文档 完整代码:组件代码 Vue组件开发 这篇文章主要是记录自己在使用VuePress过程中所遇到的问题以及如何一步一步的解决问题. 安装vuepress前,请确保你的 Node.js 版本 >= 8 全局安装 # 安装 yarn global add vuepress 或者:npm install -g vuepress # 新建一个 ma…

通过vue组件实现跟:Element相似的效果.需要在VuePress网站中将自己的项目中的Vue组件运行结果展示在页面中. 至于如何将组件在VuePress网站中展示请参考:https://segmentfault.com/a/1190000017242116 当项目中的Vue组件的运行结果可以在页面展示以后,接下来就是要将自己的代码展示在Vuepress网站中. 在VuePress网站中展示自己的代码 因为可以在markdown中使用Vue组件,所以可以自己专门写一个Vue组件来写一个效果跟…

前言 你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程.近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录. 文档的质量是一个软件项目健康发展的标志.对于开源项目来说,维护一个可靠而不出错的知识库.详细说明所有的细节是至关重要的.精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程…

[课程分享]IT件项目管理(企业项目甘特图案例评价.维护管理.文档管理.风险管理.人力资源管理) 对这个课程有兴趣的朋友能够加我的QQ2059055336和我联系 课程讲师:丁冬博士 课程分类:Java 适合人群:中级 课时数量:32课时 用到技术:IT软件项目配置.IT软件项目模板的制定 涉及项目:IT软件企业项目甘特图案.IT软件项目可行性报告分析.基于svn的IT软件项目配置管理案例 更新程度:完毕 课程背景: 该课程是北风品牌项目管理课程系列之中的一个<IT项目管理>课程.通过本课程的…

Swagger简介. Swagger2是一款restful接口文档在线生成和在线调试工具.很多项目团队利用Swagger自动生成接口文档,保证接口文档和代码同步更新.在线调试.简单地说,你可以利用这个工具生成你的接口文档而不是自己去写,而且生成的文档在网站上可以让别人调试. 开发环境 Eclipse+Maven+Swagger2 具体步骤 引入Maven依赖.(很多JAVA组件使用的第一步) 我的maven坐标如下 <dependency> <groupId>io.springfo…

模型文档编辑器 PowerDesigner的模型文档(Model  Report)是基于模型的,面向项目的概览文档,提供了灵活,丰富的模型文档编辑界面,实现了设计,修改和输出模型文档的全过程. 模型文档的功能如下: 为各个模型生成标准或定制的文档,并输出为RTF或HTML格式的文件 利用文档模板编辑器为模型文档提供统一的,定制的模板,类似于Word的模板功能 利用文档语言编辑器为模型文档提供各种语言,实现模型文档的国际化 既可以为每个模型生成单模型文档,也可以为几个模型生成多模型文档 文档模型编…

VS2010/MFC编程入门之二(利用MFC向导生成单文档应用程序框架)-软件开发-鸡啄米 http://www.jizhuomi.com/software/141.html   上一讲中讲了VS2010和MSDN如何安装,相信大家都已经安装好了.这一讲给大家一个简单的例子,演示如何生成单文档应用程序框架. 解决方案与工程 鸡啄米在VS2010的使用介绍中已经讲了解决方案与工程的概念,这里再重提一下.每个应用程序都作为一个工程来处理,它包含了头文件.源文件和资源文件等,这些文件通过工程集中管理.…

目录 1.什么是Gitlab Pages 2.开启Gitlab Pages 3.基本过程 4.托管markdown文档 4.1 安装sphinx等依赖 4.2 配置项目的sphinx配置 4.3 编写项目文档 4.4 创建首页索引 4.5 配置gitlab-ci.yml 4.6 生成网页 4.7 配置DNS或者hosts文件 5.预览和调试 5.1 直接使用sphinx命令生成网页 5.2 VScode+sphinx插件预览 5.3 下载Gitlab生成的网页 总结 这段时间准备软考去了,也挺久…

Atitit. 项目文档目录大纲 总集合  v2 -----Atitti.原有项目源码的架构,框架,配置与环境说明 v3 q511 -----Atitit.开发环境 与 工具 以及技术框架 以及 注意事项 v2 .docx 我们推荐的开发理念与工具与技术 -----现有数据库表说明.docx ------功能表v2 q55 - 副本.xlsx 主要对客户需求进行了解析,结构化,归纳整理 -------训练系统需求具体内容  最新版 (1).doc(客户原始需求最新版) ------Atitti.…