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

  草稿变量，含矩阵，结构体，元胞

• 应用范围比较大的变量应该具有有意义的变量名，作为“草稿变量”的的临时存储空间或者索引可以用短名字。程序员在读到这样的变量的时候，可以假定这个变量的值在没有几行之后的代码中就不会再用到。通常的“草稿变量”整数的时候用 i，j ，k ，m ，n（最好少用i，j，因为他们作为MATLAB中的永久性常量表示虚数单位的）。双精度数的时候常用 x，y 和 z 。m 表示矩阵，没有 m 表示标量
• 命名上将cell, struct 与MATLAB中最常见的 numeric array ，即数值矩阵区分开来.
• n 用于整数变量, 如n_File.
• m用于一般的矩阵，如matrix_channelHFResponse;
• c用于cell array, 如cell_temp= cell(1, 4);
• s用于 struct array， 如 stuct_user= struct(‘field‘, {}) ;

• matrix，cell，stuct后面的channelHFResponse， user用来表示有特定含义的中间变量，比如matrix_channelHFResponse，用来表示计算channelHFResponse时中间变量。

  函数

• 函数名应该采用小写字母，函数名应该是具有意义的，下划线分割单词
  如采用： compute_total_width（）避免compwid（）
• 前缀get/set 应该作为访问对象或者属性的保留前缀，如getobj（.）。
• 前缀compute应该用在计算某些量的函数的地方computespread（）。
• 前缀 is应该用在布尔函数的命名的地方，如 iscomplete（）。

• Find，initialize类似。

原文：https://www.cnblogs.com/gshang/p/10919989.html