0 Comments

组件六要素

发布于:2012-11-16  |   作者:广州网站建设  |   已聚集:人围观
组件六要素

组件资源库目前还不是十分流行,因此对现有资源的调查和最佳案例的推测尚不足以得出完善的结论。我们暂时以Sun 公司网站中提供的公用组件资源
库为例,列出以下需要包括的六要素(更多内容参见2.2.2 节)。

1.组件名称

在Sun 的资源库中,组件名称都是以页面标题的形式来展现的。不过在模式资源库里,也可以包含一个更为精确的“组件名称”项,提供一系列可供替换的名称。

2.组件版本号

组件的版本号与组件名称和示例(参见后文描述)的标题密切相关。和软件更新时的发布版本说明一样,版本号可以翔实地记载从一个版本到下一个版本中发生的变化。如果需要对之前实现的内容进行更新,版本号能引起开发人员的注意,而且确保开发团队能维持系统的一致性和连贯性。

3.定义

类似于模式里面的“描述”项,组件的“定义”会描述组件的目的和用途。在图2-5 中,组件B01 Features 的定义如下:

首页专题是sun.com 网站首页中一个较为复杂而又重要的部分。它可以看作是首页推介元素的容器,循环显示首页推介的3个专题内容。

4.使用方法

“使用方法”项描述了组件应于何处使用,并包含相关信息。在Sun 的“D05 Primary Index Nav”(基本索引导航)页面中,其使用方法如下:

在任何索引页上使用。如果没有额外内容,可以选择是否加入See All(查看所有)链接。

该组件被限制只能在索引页上使用,同时可以从两种方式中选择一种来实现:带See All 链接或者不带。使用方法项注明了这两点内容。

5.示例

示例为我们提供了一个鲜活、生动的组件实例。组件是经过实现后的页面元素,因此在基于网页的文档中,你完全可以添加那些带有完整功能的版本。通过实际的示例,团队内部的所有人都能直观地了解该组件的工作方式(它还能协助质保小组审核已实现版本的正确性)、外观,以及要实现它应使用何种代码。

(点击查看大图)图2-5 Sun.com的一份组件文档

6.代码

除了一个能运行的示例之外,组件文档中还应该包含一个“代码”项,链接到该组件的已实现版本(包括使用不同编程语言的版本)。如果某个开发团队用Ruby on Rails 开发了一个应用程序,用苹果的Cocoa 开发了另一个,而两者都可以使用这个组件,那么它的代码项就应当包括用这两种语言创建的版本。

飞机