Often, I need write optical simulations in the MATLAB. Often, If I do not touch the MATAB code, that I wrote, during the several weeks or more I do not recognize it, and sometimes not even understand what I wrote.
So, how you recommend improve readability of the MATLAB code?
Thank you in advance!
To improve readability of matlab code or any type of code it should be represented in proper way with proper spacing from left side. To do this firstly select entire code you can do it by using 'ctrl+a' then press 'ctrl+i' which will arrange your code in proper way. Now second thing proper commenting at proper places which will tell reader what this thing is doing and for what purpose thing thing is operating.
Proper indexing indexing is the step
and second is write comments frequently. May be at each line.
If you follow these two, you will read and understand your own code after many years.
I use a variation of the the Linux Kernel coding standards, adapted for Matlab. Basically the key things are breaking the problem into small functions with well defined arguments and return values (with sensible names), using consistent indentation (I prefer tabs over spaces with the editor set to a 8-space tabs), judicious use of whitespace around operators and above all sensible, concise variable and function names.
Comments are useful but shouldn't be overdone - each small modular function should have a comment block / help section describing how it should be used (what does it do, what are the function arguments and return values). In-code comments should be concise and clear. Obvious things needn't be commented - it is more for where you are being obscure for efficiency reasons.
In such case I usually write it part by part and put commands within %....%,that usually appears with green colour with my code in my .m file with the version I used.
Even in some cases I create subfolders and keep part1,part 2 ..like that in seperate m files.
The practices are exactly the same as for any other programming language:
1. Use a version control system.
2. Write unit tests for your functions: http://www.mathworks.com/help/matlab/matlab-unit-test-framework.html
3. Read "Clean Code" by Robert C. Martin, and follow its recommendations.
The recommendations include obvious ones, such as descriptive names for variables and functions, and not so obvious ones, such as constantly refactoring your code to keep it clean. "Clean", among other things, means really short functions with descriptive names and with as few arguments as possible.
A version control system and a good set of unit tests is what allows you to refactor your code without the fear of breaking it.
Above all, use the boy-scout rule: always leave code cleaner than you found it. If you touch any piece of code for any reason, and you notice an opportunity to make it cleaner - do it.
Writing comment is the best way . this way other programmer can also understand and improve your program in your absence. if the program is small, you can write comment for each line. and if the program is large. divide the program in sections and write single line comment for a particular section or function.
this way you or another can work after a long period over that problem/ solution.
Good book to refer for code refinement, http://www.amazon.com/Refactoring-Improving-Design-Existing-Code/dp/0201485672
To improve readability of matlab code or any type of code it should be represented in proper way with proper spacing from left side. To do this firstly select entire code you can do it by using 'ctrl+a' then press 'ctrl+i' which will arrange your code in proper way. Now second thing proper commenting at proper places which will tell reader what this thing is doing and for what purpose thing thing is operating.
- Badges
- Science topic