如何定义多行@description元数据?

时间:2019-07-29 11:46:24

标签: metadata multiline tampermonkey userscripts greasemonkey-4

以下任何一项均不起作用:

// @description  ...text1...
// @description  ...text2...

仅显示text2

// @description  ...text1...
                 ...text2...

仅显示text1

// @description  ...text1...
//               ...text2...

仅显示text1

// @description  ...text1...<br />...text2...

显示

// @description  ...text1...\n...text2...

显示文字\ n。

1 个答案:

答案 0 :(得分:1)

你不知道。通常的想法是,描述应该简洁"Microcontent",并且如果不使扩展UI更加繁琐,那么大小就不能太大。

Greasemonkey doc says

  

只是脚本操作的简要摘要,在脚本安装后以及在管理对话框中向用户显示。

Tampermonkey doc says

  

简短重要描述。

Violentmonkey doc says

  

描述脚本的简要摘要。

现在,您可以提交功能请求或拉取请求以尝试进行更改,但是我认为采用usability / TLDR /“执行摘要”方法会更好。

所以:

  1. 使用类似SEO的 有用 描述性标题
  2. 如果描述似乎需要超过128个字符(A)您做错了,和/或(B)链接到正确的Wiki / FAQ /主页。
  3. 使用the @homepagethe @supportURL键。 Tampermonkey和Violentmonkey还将使用它们将链接图标放置在各个位置。 (无论如何,您都不应该使用Greasemonkey 4+,如其他地方所述。)

所以这是一些示例:

  1. 无需描述:

    // @name     YouTube, hide all comments.
    
  2. 简短说明有帮助:

    // @name        YouTube, redirect to show only Yanni videos.
    // @description Chooses the best Yanni-related replacement for any YouTube video.
    
  3. 真的想要很多描述:

    // @name        Stack Overflow, Insta-answer with guaranteed vote magnets.
    // @description See the terms, conditions and FAQS at stackingtheodds.mil.
    
  4. 半没用的描述,但充分利用了支持URL和图标:

    // @name        Stack Exchange, replace badge icons with duckies
    // @description Does what it says on the tin.
    // @homepage    https://stackapps.com/q/8116/7653
    // @supportURL  https://github.com/BrockA/SE-misc/blob/master/Stack%20Exchange,%20replace%20badge%20icons%20with%20duckies.user.js