Stuck on an issue?
Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Add check to enforce comment style
See original GitHub issueFor comments, we use the following conventions:
- Python:
-
# This is a single-line comment. -
# This is a multi-line XXXXXX# XXXXXXXXX comment.
- JavaScript:
-
// This is a single-line comment. -
// This is a multi-line XXXXXX// XXXXXXXXX comment.
A pre-submit check needs to implemented to enforce this style in scripts/pre_commit_linter.py. This check can (probably) be coupled with one of the existing checks.
Issue Analytics
- State:
- Created 5 years ago
- Comments:7 (4 by maintainers)
Top Results From Across the Web
Best practices for writing code comments - Stack Overflow Blog
Rule 9: Use comments to mark incomplete implementations Using a standard format for such comments helps with measuring and addressing technical ...
Read more >Code style options and code cleanup - Visual Studio (Windows)
Learn how to add an EditorConfig file to your project or codebase to enforce consistent coding styles for everyone that works in the...
Read more >Writing Checks - checkstyle
"PLAIN JAVA" mode shows the AST corresponding to the java source code without comments. In "JAVA WITH COMMENTS" you can also see comments...
Read more >Force Developers to add comments in function - Stack Overflow
I want to make sure that, every single function written by my developers should have a comment before it. It makes sense to...
Read more >multiline-comment-style - ESLint - Pluggable JavaScript Linter
This rule aims to enforce a particular style for multiline comments. Options. This rule has a string option, which can have one of...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@YashJipkate Yes, I’m working on it
Filed #8423