Jenkinsfile库方法文档
Jenkinfile library method documentation
如何向 API 调用添加文档？
我在 SCM 中创建了以下库函数。它通过 Jenkins 方法连接，并且工作正常。现在我需要添加文档，以便它显示在 */pipeline-syntax/globals 部分中。
在我的 vars/sayHello.groovy 中，我有以下签名：
#!groovy
/**
* this says hello
* @param name to greet
**/
def call(String name) {
我已经用 Javadoc 语法试过了，但它似乎不是解决方案。
我应该怎么做才能将文档放入 Jenkins 视图中？例如：
这实际上相当晦涩难懂，您必须四处挖掘才能找到它，然后通过实验使其发挥作用。如果您查看共享库的文档，然后向下滚动到 directory structure，那么您会看到一行内容：
The basename of each .groovy file should be a Groovy (~ Java) identifier, conventionally camelCased. The matching .txt, if present, can contain documentation, processed through the system’s configured markup formatter (so may really be HTML, Markdown, etc., though the txt extension is required).
这意味着你需要一个相应的vars/sayHello.txt。创建该文件后，它将用于在您要查找的位置 (https://<jenkins_host>/job/<your_job>/pipeline-syntax/globals) 生成文档。正如文档所述，您可以在文件中使用 Markdown 或 HTML 等标记语言，但扩展名必须是 .txt，并且它需要具有相同的基本名称。
这里还有两个额外的注意事项。首先是您必须 运行 至少一个 Pipeline，其中加载了共享库，然后才能显示文档。第二个与关于如何执行此操作的原始说明一样晦涩难懂：您必须重新启动（甚至可能重新启动）Jenkins 实例。
一旦这些要求都得到满足（我一直坚持重启要求，直到用户 "missedone" 在我的 Jenkins 库的 Github 问题跟踪器上向我提到它），然后文档你要的会显示。
另一个注意事项是，这些文档文件可以是指向您库中其他地方的符号链接（例如 sayHello.txt --> ../docs/sayHello.md），正如我所做的那样，它有效。
如何向 API 调用添加文档？
我在 SCM 中创建了以下库函数。它通过 Jenkins 方法连接，并且工作正常。现在我需要添加文档，以便它显示在 */pipeline-syntax/globals 部分中。
在我的 vars/sayHello.groovy 中，我有以下签名：
#!groovy
/**
* this says hello
* @param name to greet
**/
def call(String name) {
我已经用 Javadoc 语法试过了，但它似乎不是解决方案。
我应该怎么做才能将文档放入 Jenkins 视图中？例如：
这实际上相当晦涩难懂，您必须四处挖掘才能找到它，然后通过实验使其发挥作用。如果您查看共享库的文档，然后向下滚动到 directory structure，那么您会看到一行内容：
The basename of each .groovy file should be a Groovy (~ Java) identifier, conventionally camelCased. The matching .txt, if present, can contain documentation, processed through the system’s configured markup formatter (so may really be HTML, Markdown, etc., though the txt extension is required).
这意味着你需要一个相应的vars/sayHello.txt。创建该文件后，它将用于在您要查找的位置 (https://<jenkins_host>/job/<your_job>/pipeline-syntax/globals) 生成文档。正如文档所述，您可以在文件中使用 Markdown 或 HTML 等标记语言，但扩展名必须是 .txt，并且它需要具有相同的基本名称。
这里还有两个额外的注意事项。首先是您必须 运行 至少一个 Pipeline，其中加载了共享库，然后才能显示文档。第二个与关于如何执行此操作的原始说明一样晦涩难懂：您必须重新启动（甚至可能重新启动）Jenkins 实例。
一旦这些要求都得到满足（我一直坚持重启要求，直到用户 "missedone" 在我的 Jenkins 库的 Github 问题跟踪器上向我提到它），然后文档你要的会显示。
另一个注意事项是，这些文档文件可以是指向您库中其他地方的符号链接（例如 sayHello.txt --> ../docs/sayHello.md），正如我所做的那样，它有效。