New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Codeing Style] for variable description use /** */ comment style over // #3943
Comments
Only thought: /**Reader provided by caller.*/ Should be like this: /** Reader provided by caller. */ |
...and the heading I really hope the new formatter produce identical output to Prettier, as the intent of Prettier was to create a new standard:
|
@David-Else There's no |
so should I consider the discussion as everyone agreed with my proposal? |
Those are private fields... the current style guide is concerned about exported machinery, that's probably intentional. You can change specific comments but the style guide shouldn't enforce anything more IMO. |
I tend to disagree on that. While consuming private fields elsewhere in the class, a properly formed comment is provided in editors consuming the language services. While it certainly is less critical, we should still be consistent. |
also if we don't have it in style-guide, eventually it will same again so what's the point of fixing it in the first place? |
Sorry, I wasn't sure what change is being proposed. I meant that the style guide shouldn't say that private fields require JSDoc since we're already using TS and most things are self-explanatory. Of course I agree if there is a comment it should be written correctly... that much should be a given though, If not then maybe with small changes in wording. |
ok, I will start work on it |
Hi all, Is this still open? I can't see any action after the 14th of Feb so nearly half a year ago at this point. |
@Hamish-Bassett thanks, but as far as I can see most of the code adheres to the style guide so this issue is no longer relevant. |
in source code I saw variable description in front of each with format
//description
which is not following JSDocs and also it's not good in VSCode since in mouse pop up over the variable it shows description before variable in format/**description*/
.if that makes sense it will be the result :
Before:
After:
if you agree I can take care of applying changes in style guide and std modules.
The text was updated successfully, but these errors were encountered: