Remove type annotations from JSDoc?
diskdance opened this issue · 9 comments
Given that JSDoc type annotations are simply ignored in .d.ts files, I believe they are redundant and should be removed.
I disagree. Due to maintenance costs, sometimes the type annotation is directly set as "any". In such cases, it is meaningful to have detailed explanations or examples in JSDoc that reflect the types being used.
I disagree. Due to maintenance costs, sometimes the type annotation is directly set as "any". In such cases, it is meaningful to have detailed explanations or examples in JSDoc that reflect the types being used.
Thank you for your advice, but I didn't say to remove all JSDoc comments, but only type annotations (i.e. {string} in @param {string} p1 - A string param.) because it has no actual effect. Detailed explanations and examples are kept as-is.
Thank you for your advice, but I didn't say to remove all JSDoc comments, but only type annotations (i.e.
{string}in@param {string} p1 - A string param.) because it has no actual effect. Detailed explanations and examples are kept as-is.
However, due to maintenance costs, if there is a complex mixed object, its type is often directly set as "any".
JSDoc {Object} in @param {Object} p1 - A object param is meaningful to let people know that this is an object, so they will go back to check the documentation or source code - what exactly is the object here. Even if the type of typescript is any.
However, due to maintenance costs, if there is a complex mixed object, its type is often directly set as "any".
I hope you don't mind me being too straightforward here, but this is a misuse of any -- the best practice is always to describe the shape of the object as accurately as possible (as I have done in @types/oojs-ui), rather then rely on a feature that is meant to turn off all type checking features.
If I were a maintainer and saw a {Object} in JSDoc, I would then browse the source code to figure out its properties. This is what I have done hundreds of times when typing OOUI and it is totally feasible.
It is maintainers' responsibility to type them, not users.
It is maintainers' responsibility to type them, not users.
Well said, then you go ahead and do it. Until the types of all objects and arrays are accurately described, I oppose removing comments prematurely.
@AnYiEE Could you please give a full list of typings you think inaccurate "due to maintenance costs"? In such case problems can be solved faster, thanks!
@AnYiEE Could you please give a full list of typings you think inaccurate "due to maintenance costs"? In such case problems can be solved faster, thanks!
Maybe you can search globally for the keyword any. I recommend basing it on the source code in this pull request, as they have been renovated based on the latest upstream source code. Thanks for your work.