[]
        
(Showing Draft Content)

给命令添加说明

有时,命令的功能或用法不好理解,或者是命令有一些特别的策略需要说明。为了让使用者更好的使用命令,应该给命令添加一些描述,详细说明命令的功能,用法或特殊策略。

通过注解 @Description 可以实现此功能。

@Description("描述文本可以是多行的\r\n从这里开始是第二行描述了,如果描述文本特别长,是会自动换行的,命令的描述会出现在所有属性之后")
public class MyPluginServerCommand extends Command implements ICommandExecutableInServerSide {

    @Description("这里可以写一些描述")
    private String text;

    @FormulaProperty
    @Description("描述文本可以是多行的\r\n通过鼠标悬停到问号图标上查看")
    private Object formula;

    @Override
    public ExecuteResult execute(IServerCommandExecuteContext dataContext) {
        return new ExecuteResult();
    }

    @Override
    public String toString() {
        return "我的服务端命令插件1";
    }
}

效果如下:

image