How to save time when documenting code?
We show how to make documentation of script and function files much easier. Specifically, we show how to take advantage of MATLAB’s online community to create script and function files with dynamic headers and create an organized way to document your code.
00:00 -Introduction
00:06 -Click button to get a template documentation for script file
00:30 -Click a button to get a template documentation for function file
00:50 -Seach “Benjamin Pillot New MATLAB”
01:05 -Visit Benjamin Pillot’s MATLAB’s Central page
01:12 -Find “New m-file (dynamical/documented header)” link
01:18 -Find and click the “Download” button
01:51 -Look at contents of download
02:08 -Run the “userpath” command
02:19 -Drag new files into the userpath directory
02:45 -Create and delete favorite buttons
03:12 -Add a new favorite for new(‘script’) command
04:16 -Click favorite to create documented script file using template
04:20 -Add a new favorite for new(‘function’) command
04:39 -Add a new favorite for new(‘class’) command
05:12 -userpath is a great place to save your user-defined function
05:30 -Look at the new.m source code
05:40 -Update the default script file
06:14 -Make documentation easy using this technique
06:27 -Conclusion