Closed hgalytoby closed 1 month ago
选项说明的文档内容不应该被手动修改, 应该在类型的注释中对其描述进行修改: https://github.com/oh-my-live2d/oh-my-live2d/blob/main/packages/oh-my-live2d/src/types/model.ts#L18
注意类型声明的标签, 使用的是 @valueType
, 例如:
/**
* 模型的 json 文件 url 地址, 必填项
* @valueType string | string[]
*/
path: string | string[];
项目在构建文档时, 会自动根据选项的注释内容生成每个选项的文档描述
自动生成的话,是不是忘记更新了?至少类型都对不上
自动生成的话,是不是忘记更新了?至少类型都对不上
目前文档构建脚本对复杂的类型描述不太智能, 需要手动的加上 @valueType 标签明确类型描述😅
选项说明的文档内容不应该被手动修改, 应该在类型的注释中对其描述进行修改: https://github.com/oh-my-live2d/oh-my-live2d/blob/main/packages/oh-my-live2d/src/types/model.ts#L18
注意类型声明的标签, 使用的是
@valueType
, 例如:/** * 模型的 json 文件 url 地址, 必填项 * @valueType string | string[] */ path: string | string[];
项目在构建文档时, 会自动根据选项的注释内容生成每个选项的文档描述
不好意思,現在我了解了!
修改 path 说明。
昨天看到更新后发现文档没有说明切换衣服怎么使用。
看了 https://github.com/oh-my-live2d/oh-my-live2d/pull/44 ,是由
path
实现切换衣服的。