Giter Site home page Giter Site logo

Wouldn't be great if there is a feature which check if a function has been properly commented. (Feature request) about codemetrics HOT 1 CLOSED

navanshu avatar navanshu commented on July 22, 2024
Wouldn't be great if there is a feature which check if a function has been properly commented. (Feature request)

from codemetrics.

Comments (1)

spartanatreyu avatar spartanatreyu commented on July 22, 2024 2

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.