Code alignment 代码对齐改进（VS2017）

最新推荐文章于 2025-02-25 18:33:06 发布

weixin_34185560

最新推荐文章于 2025-02-25 18:33:06 发布

阅读量3.3k

点赞数

文章标签：开发工具

本文探讨了代码对齐的重要性，展示了如何通过对齐提升代码的可读性和美观性，并提供了多个示例来说明不同场景下的对齐效果。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

In mathematics you always keep your equals lined up directly underneath the one above. It keeps it clean and lets you know you're working on the same problem, for example:

y = 2x
y/2 = x
Programming is slightly different. We often have a lot of assignments underneath each other, and while they are not strictly the same as maths, there is a close relationship. As such, aligning the equals allows us to quickly spot the relationship.

Further, it makes your code so much more readable. Without alignment, code is like opening a CSV file in Notepad. But, if you open the CSV file in Excel, it becomes so much easier to read since the columns have meaning.

Compare these:

  person.FirstName = "Chris";                =>  person.FirstName  = "Chris"; 
  person.Surname = "McGrath";                =>  person.Surname    = "McGrath"; 
  person.Age = 24;                           =>  person.Age        = 24; 
  person.Occupation = "Software Developer";  =>  person.Occupation = "Software Developer"; 
  person.HomeTown = "Brisbane";              =>  person.HomeTown   = "Brisbane";

I question the sanity of anyone who thinks the first looks better or is easier to understand.

The Code alignment extension allows you to align by more than just the equals. As you start to see the benefits of alignment, you see that there is so much more to align by:

  // Ugly                 // An improvement        // Even better! 
  chris.Age = 25;      => chris.Age     = 25;  =>  chris   .Age = 25; 
  dan.Age = 23;        => dan.Age       = 23;  =>  dan     .Age = 23; 
  michael.Age = 27;    => michael.Age   = 27;  =>  michael .Age = 27; 
  jennifer.Age = 22;   => jennifer.Age  = 22;  =>  jennifer.Age = 22;

By aligning by the dot we can clearly see that we are setting the same property on each variable, and the thing that changes is the variable name.
This might seem a bit crazy now, but once you start aligning things, it's addictive.

Some more examples

  private string m_firstName = string.Empty;   =>  private string  m_firstName = string.Empty; 
  private string m_surname = string.Empty;     =>  private string  m_surname   = string.Empty; 
  private int m_age = 18;                      =>  private int     m_age       = 18; 
  private Address m_address;                   =>  private Address m_address; 

  public string FirstName { get; set; }        =>  public  string  FirstName { get; set; }    
  public string Surname { get; set; }          =>  public  string  Surname   { get; set; }
  public int Age { get; private set; }         =>  public  int     Age       { get; private set; }
  private Address Address { get;  set; }       =>  private Address Address   { get; set; } 
     
  Assert.AreEqual("expected", person.Name);    =>  Assert.AreEqual   ("expected", person.Name); 
  Assert.AreEqual(21, person.Age);             =>  Assert.AreEqual   (21,         person.Age); 
  Assert.AreNotEqual(other, person);           =>  Assert.AreNotEqual(other,      person); 
    
  switch (state)                               =>  switch (state) 
  {                                            =>  { 
     case State.QLD: city = "Brisbane"; break; =>      case State.QLD : city = "Brisbane"; break; 
     case State.WA: city = "Perth"; break;     =>      case State.WA  : city = "Perth";    break; 
     case State.NSW: city = "Sydney"; break;   =>      case State.NSW : city = "Sydney";   break; 
     default: city = "???"; break;             =>      default        : city = "???";      break; 
  }                                            =>  }

It's surprising how few developers align their code.