Welcome to OGeek Q&A Community for programmer and developer-Open, Learning and Share
Welcome To Ask or Share your Answers For Others

Categories

0 votes
237 views
in Technique[技术] by (71.8m points)

javascript - JSDoc, class and methods duplicates

I am documenting my code with JSDoc and I am having a problem. After converting Typescript to Javascript and generating documentation, the class and methods are duplicated.enter image description here

this is my typescript configuration:

{
    "compilerOptions": {
        "target": "ES6",
        "module": "commonjs",
        "lib": [
            "es6",
            "dom",
        ],
        "outDir": "./build",
        "strict": true,
        "moduleResolution": "node",
        "baseUrl": "./src",
        "typeRoots": [
            "node_modules/@types"
        ],
        "esModuleInterop": true,
        "experimentalDecorators": true,
        "emitDecoratorMetadata": true,
        "resolveJsonModule": true,
    },
    "exclude": [
        "./tests/*"
    ]
}

and this is JSDoc configuration:

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc", "closure"]
    },
    "source": {
        "excludePattern": "",
        "includePattern": ".*\.(js|html)$",
        "include": [
            "./build"
        ]
    },
    "plugins": [],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    },
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8"
    }
}
question from:https://stackoverflow.com/questions/65869789/jsdoc-class-and-methods-duplicates

与恶龙缠斗过久,自身亦成为恶龙;凝视深渊过久,深渊将回以凝视…
Welcome To Ask or Share your Answers For Others

1 Reply

0 votes
by (71.8m points)

Ok I've already fixed that, all I did is instead of generating documentation from javascript (compiled from typescript), I generated the documentation from typescript.


与恶龙缠斗过久,自身亦成为恶龙;凝视深渊过久,深渊将回以凝视…
OGeek|极客中国-欢迎来到极客的世界,一个免费开放的程序员编程交流平台!开放,进步,分享!让技术改变生活,让极客改变未来! Welcome to OGeek Q&A Community for programmer and developer-Open, Learning and Share
Click Here to Ask a Question

...