ENG1060 Lecture Notes - Lecture 3: Plain English, Matlab
30 May 2018
School
Department
Course
Professor
Comments
Green%text
•
Declared%with%percentage symbol
•
Ignored%by%MATLAB
•
Used%to%provide%additional%info
How%and%why
○
•
Impt%esp%when%prog%is%complicated
•
Used%as%documentation%to%convey%the%purpose%of%the%code%block
Rules
Comment%as%you%write%code
•
Plain%English
•
Keep%concise
•
Maintain%same%style%throughout
•
Avoid%redundant%ones%(eg.%for%simple%var%declaration%or%math%ops)
•
Sections
Declare% with%double%percentage symbol
•
Use%"Run%Section"%button%instead%of%"Run"
•
Good0practices
Indentation%>>>%structuring
Easy%to%understand%
○
Meaningfulto%others
○
Esp%for%if-statements,%when%they%get%nested%too
○
•
Well%documented%and%easily%usable
•
Week$3:$Documentation
Saturday,%5%August%2017
08:30
