1.5: Headers

Last updated
Save as PDF

Page ID: 14912

\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \) \( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)\(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\) \(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\)\(\newcommand{\AA}{\unicode[.8,0]{x212B}}\)

For each assignment for this course, you will be submitting either a script or function M-file. At the top of each file, you must include a descriptive header (as comments). They must look like the following, adjusted to fit your name, the date, etc.

% Troy Siemers
% Program Name: Assignment1.m
% Date: 10 January 2010
% Course: MA110
% Description: In this assignment, we focus on how
% matrices are entered and referenced in Matlab. We also
% use component-wise multiplication and
% matrix exponentiation.

We can not stress enough the importance of proper documentation. You maybe working with other people on coding or may return to a file that you wrote several days ago (or weeks, years, etc.). Without the comments to explain your work (to others or as reminder to yourself), it is often difficult to understand the code (and fix it when it doesn’t function properly).