Good programming practice...

조회 수: 68(최근 30일)
Raviteja
Raviteja 2011년 9월 22일
편집: Jitin Beri 2018년 11월 12일
Hello all,
Please explain good MATLAB programming practice methods. It will help to the guys who are new to programming like me.
Previously I used
for i=1:10
after following some suggestions from this answers pages I learnt to use
for i1=1:100
This is the good way to write programs.
Like this, as a professional programmer, please mention some good programming practice techniques.
It will useful to all!
  댓글 수: 2
Steven
Steven 2011년 10월 19일
However, the difference seems to be indistinguishable considering a certain precision.
tic;
for i1 = 1:100000
x = sin(i1);
end
toc
Elapsed time is 0.003597 seconds.
tic;
for i = 1:100000
x = sin(i);
end
toc
Elapsed time is 0.003569 seconds.

댓글을 달려면 로그인하십시오.

답변(16개)

Daniel Shub
Daniel Shub 2011년 9월 23일
I suggest developing a coding "style." Some good places to start are given in the FAQ:
I also would consider this book reviewed by Loren
although I should say I have not looked at it yet. It is on my list of things to do.
  댓글 수: 1
K E
K E 2012년 1월 26일
Elements of Matlab Style is great

댓글을 달려면 로그인하십시오.


Jake Bolanski
Jake Bolanski 2011년 9월 22일
It's always good to comment in front of your code so that you won't have trouble remembering why you did what you did. It also helps others recognize your code and what you're doing.
  댓글 수: 1
Jan
Jan 2011년 9월 22일
I agree. If you want to share your code, or do this ever in the future, it is a good idea to use the standard comment style of Matlab:
function [Output, ...] = Fcn(Input, ...)
% H1 line
% Help text
% [Output, ...] = Fcn(Input, ...)
% ...
% Date, author

댓글을 달려면 로그인하십시오.


Jan
Jan 2011년 9월 23일
Read the FAQ
It is very likely, that the questions, which concern other users frequently, do concern you also. It is very efficient to profit from the mistakes of others, instead to implement them by your own.
  댓글 수: 2
Bjorn Gustavsson
Bjorn Gustavsson 2011년 9월 23일
"It is very efficient to profit from the mistakes of others, instead to implement them by your own." was one of the funniest (sadly fun, funily said) statements I've come across this week!

댓글을 달려면 로그인하십시오.


Fangjun Jiang
Fangjun Jiang 2011년 9월 22일
Where do you want to start? I'll add as I come up with some.
  • pre-allocate large size variables using zeros(), cell()

Jan
Jan 2011년 9월 22일
Avoid overloading builtin functions. It happens very often, that a user creates a variable called "max" and is surprised that the MAX function does not work anymore:
max = 19;
... 100 lines later:
B = max(1:10)
??? Index exceeds matrix dimensions.
A confusing but correct error message!
  댓글 수: 1
Jan
Jan 2012년 1월 26일
@Steven: As you've found out, longer symbols do not need more time (as long as the lookup table is not poluted by EVALs). While runtime is not a problem, debug time is. "B=max(1:10)" is confusing.

댓글을 달려면 로그인하십시오.


Jan
Jan 2011년 9월 22일
Do not start a script or function by:
clear all
This removes all loaded functions from the memory. Reloading them will need a lot of time such that a program can be 100 times slower in a not so unlikely worst case.
I admit that a clear or the equivalent clear variables can help to detect crude typos in names of a variable, if this variable is existing before the script. But this is a really rare case and if a function is used, MLint detects this much better.
But there is a frightening large number of codes starting with clear all. I assume this is recommended in some tutorials which have been written without deeper insight into MATLAB.
  댓글 수: 1
Daniel Shub
Daniel Shub 2011년 10월 20일
Even the best sometimes do it:
http://blogs.mathworks.com/loren/2009/06/16/rooting-around-in-matlab-part-2/

댓글을 달려면 로그인하십시오.


Daniel Shub
Daniel Shub 2011년 9월 23일
편집: Jitin Beri 2018년 11월 12일
  댓글 수: 1
Jan
Jan 2011년 9월 23일
I wish, that you do *not* come to Answers, but proceed to the above two links immediately... But I vote the helpful links +1.

댓글을 달려면 로그인하십시오.


Daniel Shub
Daniel Shub 2011년 9월 23일
Use the functional form of load and save, and almost every other function except maybe help and doc
instead of
load filename.mat
use
data = load('filename.mat')
  댓글 수: 2
Daniel Shub
Daniel Shub 2011년 9월 23일
@jan you are correct, catching the output of load is an important piece of good practice.

댓글을 달려면 로그인하십시오.


Jan
Jan 2011년 9월 22일
Use English for comments and the help text. Although you might assume, that you will never share the code, even a discussion in this forum is much harder, if all variables and descriptions are in Italian.
  댓글 수: 1
Walter Roberson
Walter Roberson 2011년 9월 23일
This one I cannot really agree with. It trades the possibility that one might want to share a section of the code in Answers or CSSM, against the near certainty that the code will need to be easily understandable by other people in one's workplace.
There are also locations were writing the comments and help text in English would violate various language preservation laws.

댓글을 달려면 로그인하십시오.


Jan
Jan 2011년 9월 22일
Include a check of number and type of inputs if all functions.
This will cost several seconds runtime, but will save hours of debugging.

Jan
Jan 2011년 9월 23일
Read the tips for program development in the dokumentation:
And if you are on the way, read the rest of the documentation also, at least the "Getting Strarted" chapters.

Jan
Jan 2011년 9월 23일

Daniel Shub
Daniel Shub 2011년 10월 20일
  댓글 수: 1
Fangjun Jiang
Fangjun Jiang 2011년 10월 20일
+1. I remember reading Doug's post. That's a good one.

댓글을 달려면 로그인하십시오.


Daniel Shub
Daniel Shub 2012년 1월 27일
It is only fair that if I plug Doug's blog, I should plug Loren's blog also:

Raviteja
Raviteja 2011년 9월 23일
I got good help from matlab datasheets for matlab programming tips
http://www.mathworks.in/help/pdf_doc/matlab/programming_tips.pdf
  댓글 수: 10
mohammad
mohammad 2011년 9월 24일
I use this: www.google.com/bookmarks
but it's to be nice if here has itself Bookmarks

댓글을 달려면 로그인하십시오.


Steven
Steven 2011년 10월 19일
However, the difference seems to be indistinguishable considering a certain precision whatever the number of repetitions.
tic;
for i1 = 1:100000
x = sin(i1);
end
toc
Elapsed time is 0.003597 seconds.
tic;
for i = 1:100000
x = sin(i);
end
toc
Elapsed time is 0.003569 seconds.
  댓글 수: 1
Jan
Jan 2012년 1월 27일
@Steven: You have posted this detail 3 times in this thread. Please consider, that the runtime is not affected by the length of the name of the variable, because internally the variable is accessed by a memory pointer taken from a lookup-table. This lookup-table is created when the function is loaded the first time only.

댓글을 달려면 로그인하십시오.

범주

Find more on Data Import and Export in Help Center and File Exchange

Community Treasure Hunt

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

Start Hunting!

Translated by