21

How can I disable code formatting for a specific block of code in Visual Studio 2017 (C# 7)?

I have this method:

public CarViewModel(ICarsRepo carsRepo)
{
    ...

    Manufacturers = ToSelectList<Manufacturer>();
    Categories = ToSelectList<Category>();
    States = ToSelectList<State>();
}

And I would like to format it like so:

public CarViewModel(ICarsRepo carsRepo)
{
    ...

    Manufacturers   = ToSelectList<Manufacturer>();
    Categories      = ToSelectList<Category>();
    States          = ToSelectList<State>();
}

But when I press Ctrl K + Ctrl D, it goes back to what it was.

#region inspiration

I would like something to wrap the specific block of code like a #region:

public CarViewModel(ICarsRepo carsRepo)
{
    ...

    #region disable_format

    Manufacturers   = ToSelectList<Manufacturer>();
    Categories      = ToSelectList<Category>();
    States          = ToSelectList<State>();

    #endregion
}

#pragma inspiration

Or not necessarily a region, maybe a pragma used like in this code snippet:

            var parameter = 0;
            var sqlCommand = $"{parameter}";
#pragma warning disable EF1000 // Possible SQL injection vulnerability.
            this.Database.ExecuteSqlCommand(sqlCommand);
#pragma warning restore EF1000 // Possible SQL injection vulnerability.

This is more of an aesthetic preference which might not be shared by most developers, but which I quite like in my code from time to time.

3 Answers 3

32
  • Visual Studio (reference)

    • To disable formatting: #pragma warning disable format
    • To enable formatting: #pragma warning restore format
        switch (number) {
    #pragma warning disable format
            case 1:    cardinal = "one";     animal = "monkey";     break;
            case 2:    cardinal = "two";     animal = "horse";      break;
            case 3:    cardinal = "three";   animal = "pig";        break;
            case 4:    cardinal = "four";    animal = "chicken";    break;
    #pragma warning restore format
        }
    
    
  • Rider (doc)

    • To disable formatting: // @formatter:off
    • To enable formatting: // @formatter:on
        switch (number) {
            // @formatter:off
            case 1:    cardinal = "one";     animal = "monkey";     break;
            case 2:    cardinal = "two";     animal = "horse";      break;
            case 3:    cardinal = "three";   animal = "pig";        break;
            case 4:    cardinal = "four";    animal = "chicken";    break;
            // @formatter:on
        }
    
  • Combined

        switch (number) {
    #pragma warning disable format // @formatter:off
            case 1:    cardinal = "one";     animal = "monkey";     break;
            case 2:    cardinal = "two";     animal = "horse";      break;
            case 3:    cardinal = "three";   animal = "pig";        break;
            case 4:    cardinal = "four";    animal = "chicken";    break;
    #pragma warning restore format // @formatter:on
        }
    
Sign up to request clarification or add additional context in comments.

Comments

5

This matches your need. Not just C#, but also for ANY language.

Manufacturers/**/= ToSelectList<Manufacturer>();
Categories/*   */= ToSelectList<Category>();
States/*       */= ToSelectList<State>();

1 Comment

Not that it needs to, but I can't see how that works for VB, even substituting " ' ' " for " /* */ ".
2

This doesn't disable just a block of formatting but it stops Visual Studio from formatting any of your declaration statements.

enter image description here

Comments

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.