来源:fasiondog

许多UML建模工具可以自动生成文档,让需求人员、开发人员专心于需求、设计的建模。当然为了能够生成符合自己要求的模板,需对建模时的目录结构(模型和包)有所规划和要求,否则很难生成相应的文档。这要求提前了解相应的建模工具如何生成文档以及如何配置文档模板。不同的建模工具配置文档模板的方式和要求,如StarUML使用Word中的批注命令对元素模型进行遍历,而EA则通过RTF标注以及模型目录,相比之下EA的文档生成和模型的目录结构绑定的更紧,如果没有事先规划,更难生成文档。这里简单记录StarUML配置生成Word文档的模板方法和注意事项,作为StarUML帮助的一些补充。EA的文档生成,另外记述。详细的StarUML文档配置方法,详见:http://staruml.sourceforge.net/docs/developer-guide(en)/ch11.html

StarUML文档生成功能菜单在“[Tool]->StarUML Generator”,如下图所示:

创建文档模板

由于StarUML的中文支持不好,如果直接按Help中的方式创建以中文命名的文档模板会出错。可以简单的到StarUML的安装路径下,找到模板所做路径,如:D:\Program Files (x86)\StarUML\modules\staruml-generator\templates。直接复制一份已有的Word模板目录(安装后默认有一份usecase specification),然后将目录改名为所希望的名称。接着将该目录下的“Template.doc”更换为自己的文档模板,作为后续添加命令的基础文档。然后,启动“[Tool]->StarUML
Generator”在界面中更改,模板的注册名称。其详细做法,见下面各图所示。

1)复制已有的Wor的模板目录,并改名为所希望的名称,如“需求规格说明书”

2)在文档生成功能界面([Tool]->StarUML Generator)中,更改模板的注册名称

如何在Word文档中通过批注添加StarUML命令

StarUML是通过Word文档中的“批注”来标识如何将UML模型中的内容插入到文档的指定位置。其指示生成内容的语法主要是“命令+参数”的形式。如下图所示:

其中,命令只有4个,其中IF和SCRIPT很少用,分别是:

  • REPEAT ~ ENDREPEAT (如果是在表格中自动插入多条数据,需用 ENDREPTR 结尾)
  • IF ~ ENDIF (如果是在表格中自动插入多条数据,需用 ENDIFTR 结尾)
  • DISPLAY
  • SCRIPT

由于命令部分是通过“批注”中的作者来表示的,而Word又不能随便更改作者,所以需要下载StarUML提供的默认模板(其中提供了所有命令的批注,模板下载地址:http://staruml.sourceforge.net/files/template-word.zip),从其中拷贝批注来添加命令。在Word中拷贝批注,最好将批注的显示方式改为嵌入方式,见下图:

在嵌入批注的显示方式下,点击“审阅窗格”按钮,可编辑批注内容,输入参数:

命令用法

命令:REPEAT ~ ENDREPEAT

用途:遍历满足输入参数条件的模型元素,并执行REPEAT和ENDREPEAT之间的其它命令。注意,如果是在表格中增加多条数据,结尾应用ENDREPTR。注意,该命令可以嵌套,即REPEAT中嵌套REPEAT

参数:PathName;FilterType;CollectionName;Condition参数都是可选的,彼此之间使用“;”分隔,如果不指定某个参数空着即可,如::Use Case View;UMLClass;;,表示遍历目录::Use Case View中的类型为UMLClass的元素。PathName:路径名指的是模型(Model)和包(Package)的名称,可以在StarUML中选择元素后在状态栏中查看,如下图所示:

在路径前加上“{R}”表示递归该路径下的所有子模型/子包,如“{R}::Use Case View;UMLActor;;”表示递归模型Use Case View下所有的Actor。FilterType:UML模型中元素,如Class、Actor、UseCase。其也可以在StarUML中的状态栏中查看选定元素的类型,见前图。CollectionName:指的是选中元素后右键菜单里(见下图)的“Constraints”和“Collection Editor”中的Attributes/Operations等,其名字和界面中显示的一样,如“;;Constraints;”。

Condition:指定条件,如“current().Documentation != ""”

命令:DISPLAY

用途:显示元素指定的属性或者显示图形

参数:Pathname;Expression

Pathname:见REPEAT命令

Expression:指定元素的属性,使用current()表示当前遍历到的元素,current().Name表示当前元素的名称,其它属性类似。

常用的有:显示元素名称:current().Name;I

显示元素文档内容:current().Documentation

显示Tag内容:;trim(current().GetTaggedValueAsString("UMLStandard", "UseCaseSpecification", "Preconditions"));

显示约束内容,属性、操作等类似:

REPEAT ;;Contraints;

DISPLAY ;current().Name

DISPLAY ;current().Body

ENDREPEAT

显示图形:

REPEAT {R};UMLActivityDiagram;;

DISPLAY ;;  (只要在REPEAT中选定图形,此处参数默认为空即可

ENDREPEAT

命令:SCRIPT

用途:简单的JScript脚本用的不多,可以简单的添加文本前缀,如在用例名称加上“UC_”的前缀

SCRIPT new_name = "UC_" + current().Name

DISPLAY ;new_name;

更复杂一点的,比如为Use Case View模型下的每个包里的用例进行编号,其中每个用例通过添加Tag“ID”指明序号(如何添加新的Tag另外记录)。比如,包“需求管理”下的用例“创建需求申请单”,其ID为“001”,则自动生成用例编号“UC_需求管理_001”。代码如下:

REPEAT ::Use Case View;UMLPackage;;

SCRIPT package_name = current().Name

REPEAT ;UMLUseCase;;

SCRIPT uc_id = "UC_"+ package_name+"_" + current().GetTaggedValueAsString("UMLStandard", "UseCaseSpecification", "ID")

DISPLAY ;uc_id;

ENDPEAT

ENDPEAT

命令:IF ~ ENDIF

我很少用,不介绍了

示例模板(需求规格说明书)

供参考:下载地址:http://www.kuaipan.cn/file/id_14930590516188149.htm?source=1

StarUML配置Word生成文档模板的更多相关文章

  1. doxygen的使用(一)配置并生成文档

    原创文章,欢迎阅读,禁止转载. doxygen是个好用的文档生成工具,他的强大功能有很多介绍,我就不说了.自带的chm帮助手册很全面,包括功能.注释规范.怎么配置.工具用法等.doxygen的用法共3 ...

  2. SpringBoot 集成Swagger2自动生成文档和导出成静态文件

    目录 1. 简介 2. 集成Swagger2 2.1 导入Swagger库 2.2 配置Swagger基本信息 2.3 使用Swagger注解 2.4 文档效果图 3. 常用注解介绍 4. Swagg ...

  3. C#依据word模版动态生成文档

    新生开学,各院系辅导员代领校园卡.需要打印一份领取卡的协议,协议模版固定,但各院系卡的数量不同.需要从excel表格中抽取数据往word文件中填,同事咨询是否可以用word中的邮件合并功能,心想有这功 ...

  4. 配置WCF同时支持WSDL和REST,swaggerwcf生成文档

    配置WCF同时支持WSDL和REST,SwaggerWCF生成文档 VS创建一个WCF工程,通过NuGet添加SwaggerWcf 创建完成后通过 程序包管理控制台 pm>Install-Pac ...

  5. phpdoctor 安装,配置,生成文档

    window 下安装phpdoctor 1 安装php,设置环境变量path ,把php 的安装路径加上,比如php 安装在d:/php5/ 2下载phpdoctor,可以去官网下载 http://p ...

  6. 使用Sphinx为你的python模块自动生成文档

    Sphinx是一个可以用于Python的自动文档生成工具,可以自动的把docstring转换为文档,并支持多种输出格式包括html,latex,pdf等. 安装 创建一个sphinx项目 下面的命令会 ...

  7. 利用PowerDesigner逆向工程导出PDM模型及生成文档

    原文:利用PowerDesigner逆向工程导出PDM模型及生成文档 最近需要对老项目进行重构优化,由于项目都是好几年前的,相关设计资料很不全,最基本的数据库设计文档都没有,只能利用PowerDesi ...

  8. 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档(ASP.NET Core Web API 自动生成文档)

    对于开发人员来说,构建一个消费应用程序时去了解各种各样的 API 是一个巨大的挑战.在你的 Web API 项目中使用 Swagger 的 .NET Core 封装 Swashbuckle 可以帮助你 ...

  9. 使用Ldoc给Lua生成文档

    Ldoc介绍 LDoc是一个Lua的文档生成工具,过去,比较常用的Lua生成文档的工具是LuaDoc,可惜作者自从2008年之后就再也没有发布过新的版本了,说明作者基本上已经放弃维护了.而LDoc则是 ...

随机推荐

  1. Oracle11g R2创建PASSWORD_VERIFY_FUNCTION对应密码复杂度验证函数步骤

    Oracle11g R2创建PASSWORD_VERIFY_FUNCTION对应密码复杂度验证函数步骤 运行测试环境:数据库服务器Oracle Linux 5.8 + Oracle 11g R2数据库 ...

  2. 用Python最原始的函数模拟eval函数的浮点数运算功能

    前几天看一个网友提问,如何计算'1+1'这种字符串的值,不能用eval函数. 我仿佛记得以前新手时,对这个问题完全不知道如何下手. 我觉得处理括号实在是太复杂了,多层嵌套括号怎么解析呢?一些多余的括号 ...

  3. YYModel V1.0.4源码解析

    YYKit出现了很长时间了,一直想要详细解析一下它的源码,都是各种缘由推迟了. 最近稍微闲了一点,决定先从最简单的YYModel开始吧. 首先,我也先去搜索了一下YYModel相关的文章,解析主要AP ...

  4. 详解EBS接口开发之库存事务处理采购接收和退货

    (一)接收&退货常用标准表简介 1.1   常用标准表 如下表中列出了与采购接收&退货导入相关的表和说明: 表名 说明 其他信息 RCV_TRANSACTIONS 采购接收事务表 事务 ...

  5. x264源代码简单分析:x264_slice_write()

    ===================================================== H.264源代码分析文章列表: [编码 - x264] x264源代码简单分析:概述 x26 ...

  6. scala模式匹配的使用

    Scala模式匹配 Tip1:模式总是从上往下匹配,如果匹配不到则匹配case_项(类似Java中的default) Tip2:与Java和C语言不同,不需要在每个分支末尾使用break语句退出(不会 ...

  7. linux下的环境变量

    环境变量有时候要查找,但是经常忘记有哪些文件,现在做一个总结: /etc/profile                 此文件为系统的每个用户设置环境信息,当用户第一次登录时,该文件被执行.并从/e ...

  8. Description Resource Path Location Type AndroidManifest.xml file missing!

    这个问题又找了好久.国内回答的确不敢恭维. 本回答来自谷歌:   This is build issue. Go to Menu in eclipse, Project>clean then P ...

  9. 带吸附效果的ViewPager(一)

    什么叫吸附效果?先看一个示例更为直观,借用网上的一个效果图: 类似这种效果的app很多,网上的实现方法也是很多,但各种重写各种监听又令人不胜其烦,今日突发奇想,顺着自己的思路实现了类似的效果,不敢独享 ...

  10. 后端分布式系列:分布式存储-HDFS NameNode 设计实现解析

    接前文 分布式存储-HDFS 架构解析,我们总体分析了 HDFS 架构的主要构成组件包括:NameNode.DataNode 和 Client.本文首先进一步解析 HDFS NameNode 的设计和 ...