We don't generally put modification dates or histories in our source files, the repository tracks changes for us.
Matlab comment card code#
If you are not using a source code control system then: We put a block of comments right after the initial function line in (most of) our m-files. We keep our code in a Subversion repository and use the keywords functionality for writing this sort of information into the header comments of the m-file when it is committed to the repo. Since git uses hashes of files, you can't change the content of the file, without git thinking that it's been updated. $Author:, etc., are formatted for use with CSV/SVN. (I've just spotted a bug - the year should be before the company name in the copyright line. The Examples: and See also: lines are formatted in a way the works with the help report generator. If you have different use cases (maybe with and without optional arguments), then you should describe each one. It is important that this comes straight after the function definition line. The first line of the help documentation is known as the H1 line, and is used by the function lookfor, among others.
(You'll obviously want a different company in your copyright statement.) % Copyright: Health and Safety Laboratory 2010 % = TESTFUNCTION(INPUTARGS) Explain usage here %TESTFUNCTION Summary of this function goes here The basic template for documentation that I use is function = TestFunction(inputArgs) You just type new at the command prompt, then the name of the function, and it sorts out the rest.
Matlab comment card update#
HIm.I have a function in the MATLAB Central File Exchange that helps you document your function in a standard way, and works with version control software (CVS and Subversion not git) to automatically update the author field and time of modification. if strcmp(evt.SelectionType, 'double') & strcmp(evt.SelectedPart, 'label')Īnswer = inputdlg(]) Įnd % Reset the |ButtonDownFcn| callback function with the current |myData| % value. Use this information to % scale all line ROI measurements. % When you double-click the ROI label, the example opens a popup dialog box % to get information about the actual distance. With this information, you can calibrate all the ROI measurements to real world units. The popup dialog box prompts you to enter the known distance and units for this measurement.
This function listens for the 'ROIClicked' event, using event data to check the type of click and the part of the ROI that was clicked. This function opens a popup dialog box in which you can enter information about the real-world distance and units. Set(src, 'Label', 'Color',color) Įnd Create Callback Function to Update Measurement UnitsĬreate the function that is called whenever you double-click the ROI label. % Apply the scale factor to line length to calibrate the measurements. The % line changes color as it gets longer or shorter.Ĭolor = (ceil(64*(mag/)),:) % Choose a color from the colormap based on the length of the line. Uimenu(c, 'Label', 'Delete All', updateLabel(src,evt) % Add a custom option to the line ROI context menu to delete all existing % line ROIs. Using the % |beginDrawingFromPoint| method, you can draw multiple ROIs. % Begin drawing the ROI from the current mouse location. When you click on the line % ROI, the |updateUnits| callback opens a GUI that lets you specify the % known distance in real-world units, such as, meters or feet.Īddlistener(h, Get the current mouse location from the |CurrentPoint| property of the % axes and extract the _x_ and _y_ coordinates. When the line ROI moves, % the |updateLabel| callback updates the text in the line ROI label and % changes the color of the line, based on its length.Īddlistener(h, Set up a listener for clicks on the line ROI.
% Set up a listener for movement of the line ROI.
Specify the initial color of the line and % store the |myData| structure in the |UserData| property of the ROI.
0 kommentar(er)
