matlab代码规范.pdf

"MATLAB代码规范" MATLAB代码规范是编写MATLAB代码的指导准则，旨在提高代码的可读性、可维护性和可扩展性。下面是MATLAB代码规范的要点： 一、标识符命名原则 * 变量名应该以小写字母开头的大小写混合形式，例如shadowFadingTable、servingSector、rxBufferForRe userID、userPriorityProfile、mcsOneRetrieval等。 * 循环变量应该以i、j、k等为前缀，如for i_File = 1：nFiles for j_Position = 1：nPositions。 * 避免仅用最后的字母s（表示单复数）区别两个变量，例如point和points，可以用类似pointArray的形式加以区别。 * 避免使用一个关键字或者特殊意义的字作为变量名。 * 结构体的命名应该以一个大写字母开头，结构体的命名应该是暗示性的，并且不需要包括字段名（fieldname），例如Segment.length，避免用Segment.SegmentLength。 二、常数命名原则 * 命名常数（包括全局变量）应该采用大写字母，用下划线分割单词，如MAX_ITERATIONS、COLOR_RED。 * 参数可以以某些通用类型名作为前缀，如COLOR_RED、COLOR_GREEN。 三、草稿变量命名原则 * 应用范围比较大的变量应该具有有意义的变量名，作为“草稿变量”的临时存储空间或者索引可以用短名字。 * 命名上将cell、struct与MATLAB中最常见的numeric array，即数值矩阵区分开来。 * n用于整数变量，如n_File。 * m用于一般的矩阵，如matrix_channelHFResponse。 * c用于cell array，如cell_temp= cell(1, 4)。 * s用于struct array，如struct_user= struct('field', {})。 * matrix、cell、struct后面的channelHFResponse、user用来表示有特定含义的中间变量，比如matrix_channelHFResponse，用来表示计算channelHFResponse时中间变量。 四、函数命名原则 * 函数名应该采用小写字母，函数名应该是具有意义的，下划线分割单词，如compute_total_width（）。 * 前缀get/set应该作为访问对象或者属性的保留前缀，如getobj（）。 * 前缀compute应该用在计算某些量的函数的地方，computespread（）。 * 前缀is应该用在布尔函数的命名的地方，如iscomplete（）。 * Find、initialize类似。 五、编码及文档注释要求 * 代码版式：函数说明、代码设计、垂直间隔、水平间隔、缩进与对齐、注释。 * 垂直间隔：逻辑块之间、结构体定义之间、函数定义体之间、函数体内逻辑上密切相关的语句序列之间留空行。 * 换行注意事项：不要在一行使用多个语句，唯一的例外是for语句和switch语句。 MATLAB代码规范旨在提高代码的可读性、可维护性和可扩展性，遵守这些规范可以提高代码的质量和可靠性。