UML是文档化的语言



The UML Is a Language for Documenting

A healthy software organization produces all sorts of artifacts in addition to raw executable code. These artifacts include (but are not limited to)

Requirements

Architecture

Design

Source code

Project plans

Tests

Prototypes

Releases

Depending on the development culture, some of these artifacts are treated more or less formally than others. Such artifacts are not only the deliverables of a project, they are also critical in controlling, measuring, and communicating about a system during
its development and after its deployment.

The UML addresses the documentation of a system‘s architecture and all of its details. The UML also provides a language for expressing requiremens and for tests. Finally, the UML provides a language for modeling the activities of project planning and release
management.

一个良好的软件组织除了产出可执行的源代码以外,还会产生各种各样的产品.这些产品包括(但不限于)

软件需求

软件架构

软件设计

源代码

项目计划

软件测试

软件雏形

软件发布

依据开发的文化,这些产品中的一些或多或少会比另一些在态度上更认真对待.这类产品不仅仅是项目的可交付物,开发系统期间和系统部署之后,在可控性,量度性和沟通性上它们也是决定性的因素.

UML处理系统结构的文档和其它所有细节.UML也提供表达需求和测试所需的术语.最后,UML提供

项目计划活动和发行管理所需的术语

         

UML是文档化的语言

时间: 2024-10-05 14:10:01

UML是文档化的语言的相关文章

使用 Swagger 文档化和定义 RESTful API

大部分 Web 应用程序都支持 RESTful API,但不同于 SOAP API——REST API 依赖于 HTTP 方法,缺少与 Web 服务描述语言(Web Services Description Language,WSDL)类似的语言来定义使用者与提供者之间的请求和响应结构.由于没有充分的合同服务,许多 REST API 提供者使用 Microsoft Word 文档或维基页面来记录 API 用法.这些格式使协作和文档版本控制变得很困难,尤其对于有许多 API 或资源的应用程序,或者

使用Xcode HeaderDoc和Doxygen文档化你的Objective-C和Swift代码

在一个应用的整个开发过程中涉及到了无数的步骤.其中一些是应用的说明,图片的创作,应用的实现,和实现过后的测试阶段.写代码可能组成了这个过程的绝大部分,因为正是它给了应用生命,但是这样还不够,与它同等重要的还有代码的注释和文档编写.不管代码写的有多好,如果缺少了对应的好的注释文档,很有可能在将来带来麻烦.不幸的是,许多开发者都忽视或忽略了代码文档的重要性,而这非常糟糕,因为好的程序不仅仅是好的代码.它需要更多的东西. 谈到编写注释文档,显然我不是说仅仅简单的在实现文档里添加几行注释.肯定是更多的东

利用未文档化API:RtlAdjustPrivilege 提权实现自动关机

这里主要是利用NTDLL.dll中未文档化的API: RtlAdjustPrivilege 来实现提权.自动关机的功能. RtlAdjustPrivilege定义如下: NTSTATUS RtlAdjustPrivilege ( ULONG Privilege, BOOLEAN Enable, BOOLEAN CurrentThread, PBOOLEAN Enabled ) 参数含义如下:Privilege [In] Privilege index to change.            

文档化说明的重要性

用通过下面的两个示例,来说明官方给出的文档化说明的重要性.一个是MSDN上给出的说明,一个是GDIView GDI泄漏检测工具官方给出的说明.以这些官方说明为线索,可以找到我们程序出问题的地方,进而将问题解决掉. 1.聊天服务器时间的本地时区和夏时令的问题 (1)TL的聊天时间使用服务器时间,TL底层的XMPP客户端需要和服务器时间进行同步,进而获取服务器时间,用于聊天信息的时间戳.服务器传递过来的是UTC+0的时间,是字符串格式的年月日时间,不是整数时间.XMPP客户端要使用时差bias.mk

Qt的自文档化工具qdoc

在<人月神话>一书中,提及了软件工程中必备的一个概念:自文档化.所谓自文档化,就是把文档和代码合二为一,既增强了文档的可维护性,又增强了代码的可读性,一举两得,何乐而不为呢? 在Qt开发中,就有这样的自文档化工具:qdoc.使用qdoc,通常分三步走. 第一步,添加QDoc注释到必要的.cpp文件或.qdoc文件,在.h文件中添加QDoc注释是无效的. 第二步,编辑.qdocconf配置文件. 第三步,运行qdoc,默认生成HTML文档,命令如下: $xxx/bin/qdoc ./config

突发奇想之:源码及文档,文档包括源码---xml格式的源码,文档源码合并;注释文档化,文档代码化;

目前源码和文档一般都是分开的,我在想为什么 源码不就是最好的文档么? 但是一般源码都是文本text的,格式化需要人为统一规范,所以源码中的文档在现实中不是那么的易于实践. 而且 源码 不能包括图片.附件.示例代码等资源,这个又是一个难点. 后来我突发奇想,为什么不能把xml作为一种合二为一的文档呢? xml可被IDE识别,解析其中 包括 <code lang=cpp> 的标签中的文本为 代码.编译也使用这部分. 其他的标签 全部都是文档.而且可以在code 代码中 再分割,添加文档部分. 而文

NTDLL未文档化函数RtlGetNtVersionNumbers获取操作系统版本

作为新手,对获取操作系统版本号好奇过,因为曾经假象过一个场景:如果将来在windows xp环境下编译的程序,在windows xp跑会怎样, 在windows 2003,windows 7,windows 8又会怎样,如果程序在windows 7以上版本需要特殊处理又该怎样判断操作系统版本呢. 带着这个好奇也了解过GetVersion和GetVersionEx函数,他们的最低使用需求是Windows 2000,以下是一些官方的测试代码. GetVersion function #include

Swagger文档化restful接口

1.注解 @Api:用在类上,说明该类的作用. @ApiOperation:注解来给API增加方法说明. @ApiImplicitParams : 用在方法上包含一组参数说明. @ApiImplicitParam:用来注解来给方法入参增加说明. @ApiResponses:用于表示一组响应 @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息 l   code:数字,例如400 l   message:信息,例如"请求参数没填好" l   resp

KOTLIN开发语言文档(官方文档) -- 入门

1.   入门 1.1.  基本语法 1.1.1.   定义包 包说明应该在源文件的顶部: 1 package my.demo 2 import java.util.* 3 // … 并不要求包与目录匹配:源文件可以在文件系统中的任意地方. 查看:包(2.2) 1.1.2.   定义函数 函数带有Int类型参数,并返回Int类型值: 1 fun sum(a: Int, b: Int): Int { 2 return a+b 3 } 函数体可以是表达式,并可从中推断出返回值类型: 1 fun su