Question

我使用文档语法记录了Ballerina代码的公共类型和功能：

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风格的markdown文档语法用于文档。可以在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也提供此更改。因此，您可以使用每晚构建，直到发布稳定版本为止。

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

1 个答案: