架构组-文档总结

网友投稿 617 2022-05-29

架构组-文档总结

包图规范

类图规范

NS图规范

架构图规范

宏观出发

局部细节

包图规范

1. 格式

2. 关系

泛化

依赖

3. 元素

接口

构件

架构组-文档总结

节点

协作

用例

其他包或图

4. 可见性

“+” :public

“-” :private

“#” :protected

5. 绘制原则

每个包都必须有一个唯一的包名

包图中拥有的元素不得超出规范中的六种元素

最小化包间的依赖,最小化每个包中的 public , protected 元素个数,最大化每个包中 private 元素个数

包间关系不能出现循环依赖的情况

包中可以嵌套子包

包图需体现出包间的层级关系,一个层级的包放到一张图。一般情况下,只绘制第一层级的包关系即可。

6. 示例

类图规范

1. 格式

接口

抽象类

2. 关系

继承:实线+空心三角 继承父类

实现:虚线+空心三角 实现接口

组合:实线+实心菱形 成员变量

聚合:实线+空心菱形 成员变量

关联:实线+箭头 成员变量

依赖:虚线+箭头 局部变量、方法的参数或者对静态方法的调用

3. 标准

1.类间关系的格式与描述要做到准确无误,紧密贴合代码,与代码保持一致。

2.符合UML规范。

3.在UML基础上,不能有二义性,图要能表达出来明确的含义。

4.统一,整体看着整洁,一致,比如关系:继承和实现关系纵向画,其他关系横向画。

NS图规范

1. 结构

顺序结构

表示程序中的个操作是按照他们出现的先后顺序执行的

选择结构

表示程序的处理步骤出现了分支,他需要根据某一特定的条件选择其中的一个分支执行。选择结构有单选择、双选择的多选择三种形式

循环结构

直到型循环:表示从结构入口处直接执行循环体,在循环终端处判断条件,如果条件不满足,返回入口处继续执行循环体,直到条件为真时再退出循环到达流程出口处,是先执行后判断。因为是"直到条件为真时为止",所以称为直到型循环。

当型循环:表示先判断条件,当满足给定的条件时执行循环体,并且在循环终端处流程自动返回到循环入口;如果条件不满足,则退出循环体直接到达流程出口处。因为是"当条件满足时执行循环",即先判断后执行,所以称为当型循环。

注意事项

图形清晰、整齐

全局到局部思路来画

必须要有返回的结果,并且返回内容显示明确

不允许出现不属于图的元素,如指向线和注释标签

架构图规范

宏观出发

整体结构

色彩搭配

局部细节

用词表达

是否全面

模块划分粒度

模块摆放以及层级关系

图形间距离适中,避免间距过大、过小,影响美观

UML

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:接口规范文档
下一篇:黑客Alex Tapanaris与PDF文档
相关文章