Comments (1)
There's no real way for code to determine what a good comment is. A substantial amount of developers can't write good comments to begin with.
If you force developers to write comments in their functions, you might end up with bad commenting like this: (taken from here):
function hashIt(data) {
// The hash
let hash = 0;
// Length of string
const length = data.length;
// Loop through every character in data
for (let i = 0; i < length; i++) {
// Get character code.
const char = data.charCodeAt(i);
// Make the hash
hash = (hash << 5) - hash + char;
// Convert to 32-bit integer
hash &= hash;
}
}
Looking at something like JSDoc/Javadoc/whateverdoc might be more useful but sometimes even that is just noise. I don't think there is a proper way to mandate comments across all languages (and sometimes even within one langauge), just because so many different code styles would support useful comments in different ways.
from codemetrics.
Related Issues (20)
- Visual Studio 2022 support? HOT 1
- Cannot work under vue setup script HOT 3
- Option to ignore "Describe" functions HOT 1
- No metrics on `async` functions
- Export the Complexity results in excel HOT 3
- Publish to Open VSX HOT 1
- NullPointerException in IntelliJ plug-in when text selection is empty
- Support for svelte HOT 1
- Any plans to extend this for Java? HOT 2
- Intellij plugin support for IgnoredFunctionNames
- Ignore functions that contain keywords
- DX: Hard to see the causes + suggestion of Activity Bar Icon
- Flutter / Dart support? HOT 4
- [Question] Can I somehow hide color marks on minimap? HOT 1
- Exception in plugin (1.0.4) HOT 3
- integration with husky HOT 1
- Support for Cognitive Complexity HOT 3
- Feature request: Add click on Decoration icon HOT 1
- Feature Request: Support more languages (specifically C++) HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from codemetrics.