We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Suggestions to additional rules for consistency on our own code-base:
/** @inheritdoc */
// Copyright (c) Dolittle. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information.
For consistency, we’re expecting documentation to follow suit.
/** * Initializes a new instance of the {YourClass} class. */
/** * Defines... */
/** * Represents an implementation of {IInterface} [for a specific purpose, if any]. */
The text was updated successfully, but these errors were encountered:
Sounds great. Just a heads up, I think that the rules related to the jsdocs is really time consuming. I will check it out and find out what can work
Sorry, something went wrong.
Depends on what the object model provides. If it's similar to the C# Roslyn model, it should be fairly straight forward.
Example: https://github.com/dolittle-tools/DotNET.Common/blob/master/Source/CodeAnalysis/ExceptionDescriptionShouldFollowStandard/Analyzer.cs
@einari Not time consuming as in amount of work required, I meant that the linting will be really slow
Ahh.. I see.. 😊 Could be, for Roslyn you hardly notice - that compiler is super efficient in running things concurrently.
No branches or pull requests
Suggestions to additional rules for consistency on our own code-base:
JSDoc
/** @inheritdoc */
Header
Expected texts in documentation
For consistency, we’re expecting documentation to follow suit.
Constructor
Interface
Implementations
The text was updated successfully, but these errors were encountered: