Why do people not comment their code?
Table of Contents
Why do people not comment their code?
The most common reason must be that they have misunderstood the point of comments. You’re not supposed to explain what the code does because that’s already fully defined by the actual code. You’re supposed to explain why the code is implemented that way. If that’s obvious, there’s no need to add any comments.
Is it good to add comments in code?
Comments should be useful high level descriptions of what the program is doing. They should not restate something that is “obvious”. By using appropriate variable names, much of a program can be (almost) as easy to read as English.
What is the purpose of adding comments in the code?
In computer programming, a comment is a programmer-readable explanation or annotation in the source code of a computer program. They are added with the purpose of making the source code easier for humans to understand, and are generally ignored by compilers and interpreters.
How do I know if my code is bad?
Uncle Bob defines bad code as code that has the following attributes:
- Rigidity. This refers to code being difficult to change.
- Fragility.
- Immobility.
- Viscosity.
What are comments in coding?
Comments are text notes added to the program to provide explanatory information about the source code. They are used in a programming language to document the program and remind programmers of what tricky things they just did with the code and also helps the later generation for understanding and maintenance of code.
Why should a programmer indent their code?
Indentation is especially important when using multiple loops, functions, and if statements. The indentation gives you a good visual way to see what commands are inside vs. outside of a loop or if statement. All programmers indent their code.
Why are comments important in HTML?
Generally, HTML comments are for you or other developers who might be looking at the source code. Their purpose is to help the author of the code and other developers understand it better. Using HTML comments, you can explain your choices to a colleague reviewing your code or even debug a program quicker.
What does it mean to comment out code?
Filters. (programming) To temporarily disable a section of source code by converting it into a comment. 2. To disable lines of code in a program by surrounding them with comment-start and comment-stop characters.