Add comments in a standard way
1 vue (au cours des 30 derniers jours)
Afficher commentaires plus anciens
Jason
le 1 Mar 2016
Réponse apportée : Walter Roberson
le 1 Mar 2016
If we want to add commments about a line of code, in a standard/professional way, we add the comments above the code, or below the code, or in the same line of code?
0 commentaires
Réponse acceptée
Walter Roberson
le 1 Mar 2016
Above the code and on the same line of code, both. Above the code for explaining how sections will work. On the same line of code for brief notes about the particular line.
For example, if I am illustrating how to do edge detection, I would put comments in before the code talking about the approach. And then within that block I might have a line such as
YourImage = imread('cameraman.tif'); %replace with appropriate filename
to point out something specific about the line. I might even have written above that the user will need to replace the filename, but it helps if I comment right there that it is the line to be changed.
0 commentaires
Plus de réponses (0)
Voir également
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!