Search
Code Directory
 ASP
 ASP.NET
 C/C++
 CFML
 CGI/PERL
 Delphi
 Development
 Flash
 HTML
 Java
 JavaScript
 Pascal
 PHP
 Python
 SQL
 Tools
 Visual Basic & VB.NET
 XML
New Code
Spire.PDF for Java 2.7.8
Database Workbench Pro 5.6.10.0
The C# PDF Library 2020.1.5
CAD-Viewer 3DVBVIEW V4
dotConnect for SQLite 5.15
LuaStudio 9.92
EntityDAC 2.3
Devart ODBC Driver for QuickBooks 2.0
phpEnter 5.1.
Udemy Clone script 2.01
VisualNEO Web 19.11.7
VisualNEO for Windows 19.4.29.0
SentiVeillance SDK Trial 7.3
Devart ODBC Driver for PostgreSQL 3.2
SecureBridge 9.2
Top Code
SecureBridge 8.0
dotConnect for SQLite 5.9
EntityDAC 1.6
Database Workbench Pro 5.6.10.0
ATN Site Builder 3.0
ATN Resume Finder 2.0
PHP Review Script 1.0
ICPennyBid Penny Auction Script 4.0
Invoice Manager by PHPJabbers 3.0
Devart ODBC Driver for PostgreSQL 3.2
The C# PDF Library 1.0
Aglowsoft SQL Query Tools 8.2
Classified Ad Lister 1.0
Solid File System OS edition 5.1
ADO.NET Provider for ExactTarget 1.0
Top Rated
phpEnter 5.1.
Single Leg MLM 1.2.1
Azizi search engine script PHP 4.1.10
Paste phpSoftPro 1.4.1
Extreme Injector 3.7
Deals and Discounts Website Script 1.0.2
ADO.NET Provider for ExactTarget 1.0
Solid File System OS edition 5.1
Classified Ad Lister 1.0
Aglowsoft SQL Query Tools 8.2
Invoice Manager by PHPJabbers 3.0
ICPennyBid Penny Auction Script 4.0
PHP Review Script 1.0
ATN Resume Finder 2.0
ATN Site Builder 3.0
M-file Header Template 1.0
File ID: 80912






M-file Header Template 1.0
Download M-file Header Template 1.0http://www.mathworks.comReport Error Link
License: Shareware
File Size: 10.0 KB
Downloads: 11
Submit Rating:
M-file Header Template 1.0 Description
Description: To contribute to better standards of m-file documentation on the MATLAB Central File Exchange, I am proposing a template m-file header.

The template starts with the H1 line, followed by a few lines to describe what the function does in greater details, the calling syntax, a description of each input and output variable, a practical example of function usage, information concerning other m-files or mat-files that may be required for this function to run, and a "See also" line leading to closely related functions. This ends the block of header lines that are displayed in the command window by typing "help function_name".

After an empty uncommented line, a second block of commented lines presents information about the author: name, job title, email, website, dates of file creation and last file modification. Finally, there is a %---Begin code --- line and a % --- End code --- line.

I have surely overlooked to include information that other m-file authors consider essential. If you have suggestions to improve the template, I would appreciate hearing about them and I will try to include them in a future version. Please do not make a separate submission on the File Exchange for relatively minor modifications to this template. New submissions on the File Exchange that are based on existing submissions should only be considered when major changes in functionality are offered by the new submission (IMHO).

You should edit template_header.m and save a customized version of it containing your own personal info, as shown in template_dg.m. This will save you from typing repetitive author info each time you create a new m-file.

License: Shareware

Related: authors, Include, overlooked, surely, essential, suggestions, hearing

O/S:BSD, Linux, Solaris, Mac OS X

File Size: 10.0 KB

Downloads: 11



More Similar Code

It creates an m-file for a matlab function and populate with a header template describing the purpose of the function, the input and output parameters, and other relevant information.

In addition, it inserts information related to the author of the file: username, display name, computer name, windows version, and the time stamp.

The command to create a MATLAB function:

new myfun

It is also possible...



Creates a new m-file in the current directory. The m-file is created with a standard header text, giving the Matlab version, operating system, author, date and time and, optionally, the author's organization (the values for the author and...



It is M File for computing the rational coefficiants for HeartVI1 Simulink.



FARG parses an M-file (function or script) searching for function tags and lists their exact, literal syntax.

in addition, FARG displays a wide variety of file statistics.

currently, these functions are detected and listed



This function will take a given m-file, or directory of such files, and copy all necessary related function files (m and mex) to the target directory, excluding any MatLab provided ones (e.g. toolboxes).

I often have to distribute my...



The function "mydepfun" determines the dependencies of an
M-file, ignoring files inside the MATLAB "toolbox" directory. Skipping these files gives significant performance improvements over calling "depfun"...



ELIMINATE CREATE_FCN IN M-FILE OF FIG-FILE.



his package is composed in fact of 2 things :
- First thing is MATLAB M file, with a dll and a header file. This script shows how to call some functions from the dll included
- The zip file included is the complete Visual studio project,...



makehtmldoc(FILENAME) creates an html help file for each M-File matching FILENAME. This help file contains the header of the M-File (the first block of contiguous comment lines), with cross-links between each M-File matching FILENAME.



This m-file finds the periodic ACF of all the m-sequences of length 31.In this program m-sequences of length 31 are generated and its periodic Autocorrelation function is plotted.

User Review for M-file Header Template
- required fields
     

Please enter text on the image