How do you write code to make it easier for others to understand?

[ansh11]

Everyone writes code in his own style. How do you write code to make it easier for others to understand?

Do you write comments for each line of your code?

If not then when do you think you should write comments

Do you write code in self commenting code style?


Please share your c code writing experience for embedded systems

Warm regards
ansh

 

[betwixt]

Personally, I write a comment at the top of every subroutine to explain what it does and what value, if any, it returns. Any lines that are not immediately obvious are also commented.

All my programs start with a comment block to describe its purpose, the processor or platform it runs on, the date and version number and lists any libraries it needs to be included.

Commenting every line is overkill and clutters the code but anyone seeing it for the first time should be able to understand its basic function and what strategy is used to achieve it.

Brian.

 

[danadakk]

Depends, either a summary and / or line by line comments. Depends on
who I think will maintain code or is the audience and experience.


Regards, Dana.

 

[wwfeldman]

I do what Betwixt wrote
I use meaningful variable subroutine names
I also list all of the variable names and what they represent, their expected ranges
and other useful stuff that i might forget otherwise.

 

[andre_luis]

A well-structured code is somehow self-explanatory by itself, oftentimes requiring few additional comments.

 

[crutschow]

Try to imagine that you know nothing about what the program does or how it structured, then write comments to make those things clear.

 

[andre_luis]

Try to imagine that you know nothing about what the program does or how it structured

I would go further, a friend of mine said some time ago: "I add comments as much as possible to even protect the code from myself"