如何确保我的类型和函数文档出现在 Ballerina Central 中？

Question

我使用文档语法记录了我 Ballerina 代码的 public 类型和函数：

documentation {
    Wordpress Client object
    E{{}}
    F{{wordpressApiConfig}} - Wordpress connector configurations
    F{{wordpressApiConnector}} - WordpressConnector Connector object
}

public type WordpressApiClient object {
    public WordpressApiConfiguration wordpressApiConfig = {};
    public WordpressApiConnector wordpressApiConnector = new;

    documentation {Wordpress connector endpoint initialization function
        P{{config}} - Wordpress connector configuration
    }
    public function init(WordpressApiConfiguration config);

    documentation {Return the Wordpress connector client
        R{{}} - Wordpress connector client
    }
    public function getCallerActions() returns WordpressApiConnector;

};

但是，在我推送后，此文档不会出现在 Ballerina Central 的包描述中。我检查了一些确实显示文档的存储库，发现它们遵循不同的语法，其中涉及行注释和 + 号。

能否请您解释一下当前标准的文档样式是什么？如果我必须运行一个不同的文档生成命令，以便它在 Central 中正确显示。

Answer 1

您在此处使用的文档语法是旧语法。这是最近更新的，现在 Ballerina 风格的降价文档语法用于文档。可以在 https://ballerina.io/learn/by-example/documentation.html.

找到更多详细信息

因此您示例中的文档应更改为 -

# Wordpress Client object
# + wordpressApiConfig - Wordpress connector configurations
# + wordpressApiConnector - WordpressConnector Connector object

public type WordpressApiClient object {
    public WordpressApiConfiguration wordpressApiConfig = {};
    public WordpressApiConnector wordpressApiConnector = new;

    # Wordpress connector endpoint initialization function
    # + config - Wordpress connector configuration
    public function init(WordpressApiConfiguration config);

    # Return the Wordpress connector client
    # + return - Wordpress connector client
    public function getCallerActions() returns WordpressApiConnector;

};

此更改在 Ballerina 稳定版中尚不可用，但将在本周晚些时候发布的 v0.982.0 中可用。此更改也适用于 nightly build。所以你可以使用nightly build，直到发布稳定版。

如何确保我的类型和函数文档出现在 Ballerina Central 中？

How to make sure my documentation of types and functions appear in Ballerina central?

ballerina