从JavaScriptMVC开始如何完成项目之压缩文件和生成帮助文档

1、压缩文件
在厨师手册程序中加载了很多资源，如果我们想下载这个程序，需要下载很多文件，所以MVC框架提供了把这么多文件压缩成一个文件的压缩工具。

压缩脚本

在压缩你的程序之前，需要在DOC控制台执行下面命令：

C:\workspace\Cookbook>js cookbook\scripts\build.js
   steal/steal.js
   ...
   ignore ../steal/dev/dev.js
   ...
Package #0: 'cookbook/production.js'.

核实production.js已经在cookbook文件夹下已经生成。

切换到产品模型

切换到产品模型是通过修改cookbook.html文件来达到：


重新加载和确认

刷新你的页面，你可以看到只有2个脚本文件需要加载steal.production.js 和production.js。不需要再加载我们生成程序的28个文件。
至此压缩文件完成。

2、生成帮助文档

帮助文档是维护代码一个重要步骤。而JavaScriptMVC给我们提供了生成帮助文档的工具。我们只需要在代码中按框架要求添加说明，
如果编写代码帮助，请查看JavaScriptMVC文档中DocumentJS帮助文档。
我们只要执行下面这命令就可以生成像JavaScriptMVC文档这样结构的帮助文档。
js cookbook/scripts/docs.js

我们将在cookbook文件夹下面生成docs.html文件，打开这个文件就可以看到帮助文档了。

帮助文档最顶层的设计是cookbook/cookbook.md文件，打开它，我们看到下面代码：
@page index cookbook //最顶层的类

This is a placeholder for the homepage of your documentation.//程序功能的描述

至此，我们把从JavaScriptMVC开发项目所需要的事件都完成了。

从这个例子中，我们可以看到一个工程从开始到结束，经历了4个步骤：

1、创建工程
2、测试工程
3、压缩文件
4、生成文档

回头看看整个工程，是不是觉得很工整，而且代码很漂亮，不管从开发，测试，阅读，维护都可以说很酷。

本文附件下载:
• cookbook.rar (159.8 KB)

已有 0 人发表留言，猛击->> 这里<<-参与讨论


ITeye推荐

• —软件人才免语言低担保 赴美带薪读研！—