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

How to define multi-line @description metadata?

None 以下作品:

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

只显示text2

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

只显示text1

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

只显示text1

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

显示文字

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

显示文字 \n。

你不知道。总的想法是描述应该简洁 "Microcontent" 并且大小不能太大而不会使扩展 UI 更麻烦。

Greasemonkey doc says:

Just a brief summary of what the script does, presented to the user as the script is installed, and in the manage dialog.

Tampermonkey doc says:

A short significant description.

Violentmonkey doc says:

A brief summary to describe the script.

现在,您可以提交功能请求或拉取请求来尝试进行更改,但我认为采用 usability/TLDR/"Executive Summary" 方法更好。

所以:

  1. 使用SEO-like有用描述性标题.
  2. 如果描述似乎需要 超过 128 个字符 (A) 你做错了 and/or (B) Link正确的 wiki/FAQ/homepage.
  3. 使用 the @homepage and the @supportURL 键。 Tampermonkey 和 Violentmonkey 也会使用它们在不同的地方放置 link 图标。 (无论如何,您不应该使用 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. Semi-useless 描述但充分利用支持 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