来源:fasiondog 许多UML建模工具可以自动生成文档,让需求人员.开发人员专心于需求.设计的建模.当然为了能够生成符合自己要求的模板,需对建模时的目录结构(模型和包)有所规划和要求,否则很难生成相应的文档.这要求提前了解相应的建模工具如何生成文档以及如何配置文档模板.不同的建模工具配置文档模板的方式和要求,如StarUML使用Word中的批注命令对元素模型进行遍历,而EA则通过RTF标注以及模型目录,相比之下EA的文档生成和模型的目录结构绑定的更紧,如果没有事先规划,更难生成文档.这里简…

原创文章,欢迎阅读,禁止转载. doxygen是个好用的文档生成工具,他的强大功能有很多介绍,我就不说了.自带的chm帮助手册很全面,包括功能.注释规范.怎么配置.工具用法等.doxygen的用法共3步:1. 按照注释规范对代码加注释.2. 配置选项.3. 生成文档.配置选项可以使用命令行工具 doxyfen -g 生成一个配置模版,我直接使用带界面的配置向导来配.向导中的三个选项卡:1. wizard 进行大致的配置选择2. expert 进行精细的配置3. run 生成文档配置界面第一步如图…

目录 1. 简介 2. 集成Swagger2 2.1 导入Swagger库 2.2 配置Swagger基本信息 2.3 使用Swagger注解 2.4 文档效果图 3. 常用注解介绍 4. Swagger2文档导出成pdf 4.1 生成pdf的格式 4.2 生成静态文档步骤 4.2.1 配置gradle 4.2.2 生成swagger json文件 4.2.3 生成swagger markdown文件 4.2.4 markdown转pdf 1. 简介 今天是五一的一天,武汉因为疫情不能随意出去,…

新生开学,各院系辅导员代领校园卡.需要打印一份领取卡的协议,协议模版固定,但各院系卡的数量不同.需要从excel表格中抽取数据往word文件中填,同事咨询是否可以用word中的邮件合并功能,心想有这功夫研究还不如自己写代码实现.一共三个问题:1)读取Excel表格数据,2)往word模板文件中写数据,3)生成word文件. 1)C#读取Excel文件中的数据:创建OleDb连接,将Excel作为数据源,读取至DataTable中,待使用 private static DataSet LoadDa…

配置WCF同时支持WSDL和REST,SwaggerWCF生成文档 VS创建一个WCF工程,通过NuGet添加SwaggerWcf 创建完成后通过 程序包管理控制台 pm>Install-Package SwaggerWcf 也可在 工具 -> NuGet包管理器 -> 管理解决方案的NuGet程序包 安装. 配置 首先对项目添加Global.asax文件,改动如下: protected void Application_Start(object sender, EventArgs e)…

window 下安装phpdoctor 1 安装php,设置环境变量path ,把php 的安装路径加上,比如php 安装在d:/php5/ 2下载phpdoctor,可以去官网下载 http://peej.github.com/phpdoctor/,把下载的压缩包解压到任何地方 3配置phpdoctor,phpdoctor 最基本的配置 //源码路径,比如您的源码路径d:work/phptest,如下设置 source_path=“d:work/phptest” //生成的html 文档保存路…

Sphinx是一个可以用于Python的自动文档生成工具,可以自动的把docstring转换为文档,并支持多种输出格式包括html,latex,pdf等. 安装 创建一个sphinx项目 下面的命令会自动生成一个默认的Sphinx模板 执行期间,它会一步步的询问对模板的设置,除了一些必须填写的选项,大部分填写默认值就行了,你会遇到这样一条叫autodoc的,需要选择yes 然后默认的目录就生成了,大概是这个样子 现在执行如下指令,就会生成一份空文档,存放在/build/html里,点击index…

原文:利用PowerDesigner逆向工程导出PDM模型及生成文档 最近需要对老项目进行重构优化,由于项目都是好几年前的,相关设计资料很不全,最基本的数据库设计文档都没有,只能利用PowerDesigner逆向工程导出PDM模型及生成word文档:以下简单介绍导出模型操作步骤(以下演示操作是从SQL Server中导出) 第一步:  先打开 PowerDesigner 点击右上角文件按钮 第二步点击建立新模型,弹出new model对话框-点击physical Data Model 建立模型…

对于开发人员来说,构建一个消费应用程序时去了解各种各样的 API 是一个巨大的挑战.在你的 Web API 项目中使用 Swagger 的 .NET Core 封装 Swashbuckle 可以帮助你创建良好的文档和帮助页面. Swashbuckle 可以通过修改 Startup.cs 作为一组 NuGet 包方便的加入项目.Swashbuckle 是一个开源项目,为使用 ASP.NET Core MVC 构建的 Web APIs 生成 Swagger 文档.Swagger 是一个机器可读的 R…

Ldoc介绍 LDoc是一个Lua的文档生成工具,过去,比较常用的Lua生成文档的工具是LuaDoc,可惜作者自从2008年之后就再也没有发布过新的版本了,说明作者基本上已经放弃维护了.而LDoc则是一直在更新中,所以现在选择LDoc来给Lua生成文档是更好的选择,LDoc的Github主页. LDoc的一个优点就是,它的目的是为了和LuaDoc兼容并且拓展LuaDoc的功能而制作的,所以LuaDoc能够使用的标签LDoc也都可以使用.LDoc还有一些其他的LuaDoc不具备的优点,比如 LDo…