dast.wsrpc接口注解格式

使用示例

import dast.wsrpc.genapi,
std.array;

auto app = appender!string;
gendts!(typeof(app), modules)(app);

其中modules为模块的AliasSeq序列,为模块中所有@Action修饰的函数生成对应的ts声明
每个函数只能修饰一次@Action

注解格式

@Action:
/// 函数说明
@"返回值说明"@type("自定义返回类型") void func(
    @"参数1说明"int a,
    @"参数2说明"uint[] b,
    @type("自定义参数类型") @"参数3说明" string c = null) {
}

对应ts声明:

/**
 * 函数说明
 * @param a 参数1说明
 * @param b 参数2说明
 * @param c 参数3说明
 * @returns 返回值说明
 */
func(a: number, b: number[], limit?: 自定义参数类型): 自定义返回类型

WSRequest类型的参数会被忽略
目前函数说明只支持一行
其中函数说明所在行和函数所在行间隔不能超过1行,一般将返回值说明和自定义返回类型放在同一行,若返回值说明有多行,在代码中使用\n转义字符代替换行符
可选参数后自动添加?

类型转换规则

  1. typeof(null)类型,ts中类型为null
  2. 数字类型转换为number,布尔型转换为boolean,字符类型转换为string
  3. 可转换为const(char)[]的数组类型,ts中类型为string
  4. 若参数类型在ts中没有对应类型,则ts中类型为any
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。