Home > By category > Scripts >Development Tools > M-file Header Template



M-file Header Template

  • Downloads: 
  • Views: 
  • Rating:

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.

Free download from Shareware Connection - To contribute to better standards of m-file documentation on the MATLAB Central File Exchange, I am proposing a template m-file header.

Publisher: Denis Gilbert | License: Shareware
Version: 1.0 | Size: 10 KB | Platform: Matlab, Scripts
Released Date: 10-05-2013 | Rating: 0 | Title: M-file Header Template

Author Url: http://www.mathworks.com
Program Info Url: http://www.mathworks.com
Download Url: http://www.mathworks.com/matlabcentral/fx_files/4908/1/template_header.zip

More downloads from M-file Header Template publisher Denis Gilbert:

nancorrcoef - Computes Pearson's product moment correlation for input vectors that contain NaN values.

resize_legend - Changes LEGEND fontsize while maintaining proper alignment between the legend's text strings and line symbols.

M-file Header Template keywords:
M-file Header Template related downloads:

Creating function files with a header template - It creates an m-file for a matlab function and populate with a header template describing the purpose of the function

Open new m-file with standard header text in editor - Creates a new m-file in the current directory

exportToZip: Identifies the dependencies of an M-file and creates a ZIP file - The function "mydepfun" determines the dependencies of an M-file, ignoring files inside the MATLAB "toolbox" directory.

M File Computing Rational Coefficiant For Heart VI1 Simulink - It is M File for computing the rational coefficiants for HeartVI1 Simulink.

farg: a pedestrian M-file parser showing all used functions' syntax - FARG parses an M-file (function or script) searching for function tags and lists their exact, literal syntax.

Shareware Connection periodically updates pricing and software information of 'M-file Header Template' from company source 'Denis Gilbert' , so some information may be slightly out-of-date. You should confirm all information before relying on it. Software piracy is theft,  Using 'M-file Header Template' crack, password, serial numbers, registration codes, key generators is illegal and prevent future development of M-file Header Template.

New Reviews

PictBear - Nowadays, a majority of PC users resort to digital image editing once in a while. It may be required for retouching image captured in smart phones or for creating an album in Facebook. For some people, tinkering with digital images is a pastime ...

Viper Antivirus - Even a few years back, PC users had very few choices when it came to picking up an antivirus. Over the years, malware and rogue app development has reached new heights, resulting in emergence of several new PC security firms in the arena. Vipre ...

Edius Pro - In the last few years, NLE video editor segment has become somewhat populated than earlier, with big names like Sony vying for attention with established behemoths like Adobe. However, Adobe’s move to subscription only model has deterred ...

DataLocker SkyCrypt - Storing data in external hard drive is what any PC user can resort to but Cloud storage is gaining popularity with time. It gives you more flexibility and you can avail free and cheaply priced data storage in cloud as well. The only aspect that ...

Autodesk Smoke - Autodesk is the company well known for making some of the most feature rich and versatile tools for 3D modeling, animation and engineering design related work. Its Smoke is a Mac OS specific app that is aimed at professionals involved in ...

Sigma Internet Monitoring - There is no denying the huge importance of internet in human life. Without the web, it has literally become imposable to carry on a lot of personal and professional activities, irrespective of your age, gender and qualification. While the web ...

Freemake Video Converter - Video conversion can become a necessity for average PC users who find it increasingly hard to manage an ever growing collection of media and video files. The DVDs, videos obtained from web and clips shot with mobile devices keep growing. Over ...

Pixelmator - There is no denying the fact that Mac users are often left with fewer third party app choices than those who use Windows based PCs. However, when it comes to imaging, the situation is a little better. If you want a versatile image editor for Mac ...

CleanMyDrive - PC experts unanimously agree that using Macs tend to be a smoother and faster experience than running Windows based PCs but the Apple laptops and desktops also need maintenance and performance tweaking, occasionally. Regular web browsing, ...

Serif MoviePlus X6 - It is no longer the norm that studio professionals deal with video editing and adding effects exclusively. Average PC users also need to deal with video clips derived from multiple sources from time to time. The abundance of video editing apps ...




New Downloads

Cool Record Edit Deluxe
2015

Cool Record Edit Deluxe can
record sound from tapes, LPs,
live performances, Internet
radio, TV, DVD, or any other
sound ...

fig2texPS - Export Matlab
Figure to LaTeX

The aim of this function is to
create a tex-code picture of a
Matlab figure in PSTricks
syntax

Rooh.it Instant
Highlighter: Save and Share
`parts` of web-pages

Add a highlighter pen to your
blog: anyone can then make
'highlights on any part of
your page' and automatically
post ...

Chat

A plugin to talk online with
the other users of a blog.

pentagonal tiling of the
Poincare Disc

pic shows recursion level of 7

Diversity

Plot between Ebno and SER in
the presence of diversity

Formulation of Ybus by
singular transformation
method of an IEEE 14 bus
system

This programs explains the
formulation of Ybus by
singular transformation method
of an IEEE 14 bus system

WP Dessert Menu

This little plugin has one
simple purpose, to put a
WordPress Nav Menu in your
Admin Bar.

EWMA St.Dev.

This code calculates the
Exponentially Weighted Moving
Average Standard Deviation

Loved.by Pro

Would you like to be paid for
blogging or writing on your
website? It's simple! Loved.by
Pro will make any link to a
...

color dot plot

Color Scatter Plot for random
data point visualization

Pareto Front Using Fitness
Sharing

This code finds and plots the
Pareto front of the following
problem