学步园

    对于一门能自动缩进和自动调整的语言，Matlab似乎不怎么需要特别的代码风格。但是编了很长的程序段，如果让它随意的摆在那，看着也是很不爽的。那采用怎样的注释风格呢？可以使用和C/C++一样的代码注释风格，当然也可以使用Matlab工具箱中的注释风格，或者自己规划一种代码风格，只要要在自己眼里看的过去就行。风格问题，有些属于“萝卜白菜，各有所爱”问题，自己舒服就行。曾经看到一个师妹写的代码，每行代码总是随意的堆放着，让我看着撞墙的心都有了，她仍能安之若素。或许，这也是特色。

    但是，定下一些规矩，总会使编程更加方便；并且，如果你编的程序要给别人使用，就要按照比较标准的风格去编程。按照从小到大的顺序，注释可以分为变量、语句、代码段和函数的编写规范。至于变量和语句，这里就不多讨论了。关于代码段，感觉Matlab比较好的方法是按功能划分，每个大的功能独立成段，和上下段之间用空格区分。而函数的注释，其实可以按照Matlab的标准工具箱中的函数的注释一样，或者用help命令看到的注释一样，下面举个例子：

function [ histogram ] = calcolorhistogram( varargin )
%CALCOLORHISTOGRAM calculate color histogram of rgb image in hsv space.
%   HISTOGRAM=CALCOLORHISTOGRAM(IMAGE) transfers the IMAGE frome rgb space to hsv and
%   count the H elements of 16 bins and return the HISTOGRAM of 16 bins
%
%   HISTOGRAM=CALCOLORHISTOGRAM(IMAGE,BINS)transfers the IMAGE frome rgb space to hsv and
%   count the H elements of specified BINS and return the HISTOGRAM 
%
%   Class support for inputs IMAGE: 
%      float: uint8,double

%   Authors:Xia zhaoqiang(xiazhaoqiang@gmail.com)
%   Date:2011.11.16

% parse possible input arguments
nvars = length(varargin);
if nvars == 1
    image = varargin{1};
    bins = 16;
else
    image = varargin{1};
    bins = varargin{2};
end

通过这个例子，可以比较清楚的看出所要求的Matlab函数的标准注释风格：起始行表明函数功能；接着的几行，用大写表示用法，然后注明里面参数的含义；最后部分加上些备注的信息。

    当然，实际上Matlab的注释风格比现在讨论的要严谨的多，大家可以参考《MATLAB 编程风格指南》这篇文档。