2.2. 用元数据描述您的用户脚本
每个用户脚本都含有一段元数据,用来向 Greasemonkey 描述这个脚本自身的信息:发行者,执行规则等等。
// ==UserScript==
// @name Hello World
// @namespace http://diveintogreasemonkey.org/download/
// @description example script to alert "Hello world!" on every page
// @include *
// @exclude http://diveintogreasemonkey.org/*
// @exclude http://www.diveintogreasemonkey.org/*
// ==/UserScript==
这里有六条独立的元数据信息,作为一个整体包含在注释中。元数据以 // ==UserScript==
开始,以 // ==/UserScript==
结束,其内容要包含在 //
注释里面。这段注释可以放在用户脚本的任何部位,但经常会放在靠近顶部的地方。
现在让我们按顺序逐条解释。
字段名以 @
开始
字段名 | 必要 | 多次定义 | 说明 | 格式 |
---|---|---|---|---|
name | N | N | 名字 | |
namespace | N | N | 命名空间 | |
description | N | N | 描述 | |
include | Y | 包含 | 通配符 | |
exclude | Y | 排除 | 通配符 |
namespace
用它来区分名称相同但是作者不同的用户脚本。如果您有一个域名,您可以使用它作命名空间。如果不存在,将会默认使用下载用户脚本的网站域名。
description
这是关于用户脚本功能的描述。在您第一次安装脚本时,它将会在安装对话框中显示,之后会在“管理用户脚本”对话框中显示。描述不应多于两句。
exclude
exclude
规则优先于 include
。