提取jasmine规范描述并将其作为@description插入jsDoc文档中

时间:2015-12-30 19:44:22

标签: javascript jasmine gulp karma-runner jsdoc

我最近开始使用jsDoc来记录代码库。我想知道我是否可以使用我用jasmine为我记录的模块编写的规范。关于这些规范中的每种方法,有大量信息。有没有办法检索这些信息?

describe('.add()', function () {
    ...
    it('throws error if "key" argument is not String type', function () {
        expect(function () {
            collection.add(123, 1);
        }).toThrow(new Error('Add failed, argument "key" is not String type'));
    });
    ...
});

我从这些规范中获得了大量信息,我认为浪费这些信息是一种琐事。我想把它移到@description。我怀疑有两种方法可以做到。一个来自jsDoc使用插件或gulp命令,另一种方式是来自karma,当运行测试时,它可以自动附加soruce文件中的函数的文档数据。

.add()
    adds value to collection
    throws error if "key" argument is not String type
    throws error if "key" argument is undefined
    throws error if "value" argument is undefined
    throws error if "metadata" argument is not Object type {key:value}
    throws error if it tries to attach metadata to value that is not Object type {key:value}
    returns stored value
    overwrites previous value if using same key
    appends metadata to stored value

0 个答案:

没有答案