Appearance
格式化
格式化能很快将源代码布局按照建议标准保持一致。 这令代码看起来专业且易于阅读。 设计良好的代码在未来对作者和其他用户来说更容易分析。 若要启动格式化,请单击 位于 工具菜单里的格式化,或按 Ctrl+,。
常规
在格式化中提供以下动作类型以便正确格式化代码:
- 用指定内容替换某些行;
- 对齐语言运算符;
- 将注释插入文件标题;
- 在函数、结构、类及其方法之前插入注释;
- 在文件末尾插入注释。
基于上述动作类型,格式化进行以下调整:
空格和空行
删除不必要的空格符可令您编写的代码更紧凑,从而改善其观感。 此外,格式化将每个制表符替换为三个空格,以避免在第三方程序中打开时可能导致的格式失真。
格式化删除空格:
- 在行的末尾;
- 在 ";" 之前;
- "if" 和 "(", "while" 和 "(", "for" 和 "(", "switch" 和 "(", "return" 和 "(" 之间。
- 在 ";" 之后且在 "for()" 之内;
- 在 "!" 之后;
- 在 "(" 和 ")" 附近;
- 在 "<" 和 ">" 附近;
- 在 "|" 和 "^" 附近;
- 在 "+", "-", "/" 和 "%" 附近;
- 在 "[" 和 "]" 附近;
- 在 "==" 和 "==" 附近;
- 在 "!=" 和 "!=" 附近;
- 在 "<=" 和 ">=" 附近;
- 在 "+=" 和 "+=" 附近;
- 在 "-=" 和 "-=" 附近;
- 在 "=" 和 "=" 附近;
- 在 "/=" 和 "/=" 附近;
- 在 "<<" 和 ">>" 附近;
- 在 "," 和 "=" 左右侧各一个空格。
格式化设定:
- 在 "||" 和 "&&" 左右侧各一个空格 (结果: " || " 和 " && ")。
其它替换:
- 在 "int* a" 类型的构造器中, 字符 "*" 和 "&" 指的是一个变量而不是类型,所以这个设计被替换为 "int *a";
- 双重空行由一行替换。
格式化之前
bash
void myFunction()
{
if (I < 10)
{
printf (“Hello\n”) ;
if (I < 5 )
{
printf (“i<5 !\n”) ;
if (i < 3)
{
printf (“i<3 !\n”) ;
if (i < 2)
{
}
}
}
}
}
格式化之后
bash
void myFunction()
{
if(I<10)
{
printf(“Hello\n”);
if(I<5)
{
printf(“i<5 !\n”);
if(i<3)
{
printf(“i<3 !\n”);
if(i<2)
{
}
}
}
}
}
无论 MetaEditor 设置 如何,格式化的制表符总是等于三个空格。
当格式化要考虑行间对齐时则排除替换
以上指定的格式化替换规则在某些情况下不适用。 这样做是为了不违反相邻行上的版权对齐规定。 格式化由以下关键字和符号识别下一行的行间对齐:
- "//" ― С 风格的注释符号;
- "{" ― 开口大括号;
- "}" ― 封口大括号;
- "return" ― "return" 操作符;
- "delete" ― "delete" 操作符;
- "=" ― 等号;
- ":" ― 冒号;
- "." ― 句号。
如果格式化在前一行或随后一行中找到与上述单词或符号相同的位置,则不会进行替换。
格式化函数和操作符
- 在函数/操作符类型声明的开口和封口 "{" 和 "}" 符号之前加入两个空格。
- 位于函数/操作符的 "{" 和 "}" 符号之间的每一行,操作符开始之前均放置三个空格。
- 在未封口 "{" 或 "}" 符号的同一行内有文本情况下, 这些符号和文本会被整理到不同的行。
- 考虑到前一行的内容,也执行对齐。 如果括号未封闭,或者算术表达式在前一行中尚未完整,则当前行从前一行的 "(" 或 "=" 的第一个位置开始。
- 条件分支 "else" 总是设定与 "if" 相同。
格式化之前
bash
void myFunction() {
int k[10],t=0;
for(int i=0;i<10;i++){
k[i]=i;
t+=i;}
if (button==name) {
bool state=ObjectGetInteger(0,name,OBJPROP_STATE);
if(!state)
ObjectSetInteger(0,name,OBJPROP_STATE,false);}
else {
ObjectSetInteger(0,name,OBJPROP_STATE,false);}
}
格式化之后
bash
void myFunction()
{
int k[10],t=0;
for(int i=0;i<10;i++)
{
k[i]=i;
t+=i;
}
if(button==name)
{
bool state=ObjectGetInteger(0,name,OBJPROP_STATE);
if(!state)
ObjectSetInteger(0,name,OBJPROP_STATE,false);
}
else
{
ObjectSetInteger(0,name,OBJPROP_STATE,false);
}
}
当声明结构、类和枚举时进行对齐
这种表述也适用于所谓的两级制表:
- 声明成员/方法的指定类型之前放置三个空格;
- 声明结构或类的成员及方法时,其名称要从每一行的第 22 个字符位开始指定;
- 访问成员和方法的定域符 ("private", "protected", "public" 和 "virtual") 要与 "class" 保留字对齐。
格式化之前
c++
class CTradePad {
private:
int m_rows;
int m_columns;
int m_button_width;
int m_button_height;
int m_top;
int m_left;
int m_left_previous_header;
};
格式化之后
c++
class CTradePad
{
private:
int m_rows;
int m_columns;
int m_button_width;
int m_button_height;
int m_top;
int m_left;
int m_left_previous_header;
};
注释对齐
声明和定义中的注释有不同的对齐方式:
- 函数或方法定义中的第一级注释与左侧对齐(没有缩进);
- 声明中的第一级注释与每行的第三个字符位对齐;
- 随后级别的注释与它们所处操作符的相应级别等同。
格式化之前
bash
void myFunction() {
// 第一级注释
int k[10],t=0;
for(int i=0;i<10;i++){
k[i]=i;
t+=i;}
if (button==name) {
bool state=ObjectGetInteger(0,name,OBJPROP_STATE);
// 第二级注释
if(!state)
ObjectSetInteger(0,name,OBJPROP_STATE,false);}
else {
ObjectSetInteger(0,name,OBJPROP_STATE,false);}
}
class CTradePad
{
private:
int m_rows;
// 行数
int m_columns;
// 列数
int m_button_width;
// cell width
};
格式化之后
bash
void myFunction()
{
// 第一级注释
int k[10],t=0;
for(int i=0;i<10;i++)
{
k[i]=i;
t+=i;
}
if(button==name)
{
bool state=ObjectGetInteger(0,name,OBJPROP_STATE);
// 第二级注释
if(!state)
ObjectSetInteger(0,name,OBJPROP_STATE,false);
}
else
{
ObjectSetInteger(0,name,OBJPROP_STATE,false);
}
}
class CTradePad
{
private:
int m_rows;
// 行数
int m_columns;
// 列数
int m_button_width;
// 单元宽度
};
插入注释
如果文件头缺失,则将以下形式的注释插入到文件头中:
c++
//+------------------------------------------------------------------+
//| ProjectName |
//| Copyright © 2009, CompanyName.|
//| http://www.companyname.net |
//+------------------------------------------------------------------+
当缺失时,以下形式的注释会插入函数、类、结构等之前:
c++
//+------------------------------------------------------------------+
//| |
//+------------------------------------------------------------------+
在文件末尾插入以下类型的截止注释:
c++
//+------------------------------------------------------------------+