Add comments in a standard way

3 次查看(过去 30 天)
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?

采纳的回答

Walter Roberson
Walter Roberson 2016-3-1
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 个)

类别

Help CenterFile Exchange 中查找有关 Loops and Conditional Statements 的更多信息

标签

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Translated by