C# стандарты кодирования для частных переменных членов

Question

Я видел два общих подхода к стандартам кодирования для частных переменных-членов:

class Foo 
{ 
    private int _i; 
    private string _id;  
} 

и

class Foo 
{ 
    private int m_i; 
    private string m_id; 
} 

Я считаю, что последний приходит из C++. Кроме того, многие люди указывают тип перед переменной-членом (например, double m_dVal), чтобы указать, что это не постоянная переменная-член типа double?

Каковы соглашения в C#?

Answer 1

Я предпочитаю использовать свой первый пример, или авто-свойство, как это, которые избегают, имеющая частные полей, определенных в классе на всех:

public String MyString { get; set; } 

Используйте prop фрагмент кода, чтобы сделать это очень быстро.

Answer 2

Помимо двух вы упомянули, очень часто в C# нет префикса для частных членов.

class Foo 
{ 
    private int i; 
    private string id; 
} 

Это то, что я использую, а также то, что рекомендуется в Microsoft's internal naming guidelines.

Answer 3

Как я помню из чтения Framework Design Guidelines, для частных переменных-членов не существует условного соглашения, за исключением того, что нельзя использовать венгерскую нотацию, и нельзя использовать первую букву имени переменной (используйте Camel-casing). В книге есть цитаты, которые поддерживают оба ваших примера, а также не используют какой-либо префикс.

Лично я предпочитаю префикс «m_».

Answer 4

Как отметил Brad Abrams: internal coding guidelines:

Не используйте префикс для члена переменных (_, m_, s_ и т.д.). Если вы хотите различать локальные переменные-члены и , вы должны использовать «this.» в C# и «Me.» в VB.NET.

Answer 5

Я, как правило, придерживаюсь первого соглашения, простого подчеркивания. Я также не указываю тип в имени, потому что у меня Intellisense говорит мне, что это (я знаю, это может быть костыль).

Лучше всего проверить со своими коллегами или товарищами по команде, и просто принять решение по конвенции, некоторые из них являются произвольными.

Answer 6

Я предпочитаю не использовать какой-либо префикс вообще для переменных-членов. Для тех, кто объявлен вне метода, я использую «this.memberVariableName», чтобы отличить их от объявленных внутри метода.

Answer 7

Общее руководство от Microsoft здесь:

http://msdn.microsoft.com/en-us/library/ms229002.aspx

Автоматические свойства в C# являются большими, и я использует тогда, когда я могу, но бывают случаи, когда они не работают для меня, например, при выполнении типа или проверка значения по установленному методу.

В целом: используйте кожух верблюда и не префикс своего имени ничем, как подчеркивание или префикс типа.

public int Age {get; set;} 

или

private int age; 
public int Age 
{ 
    get { return age; } 
    set 
    { 
     if(value < 0) 
      throw new InvalidOperationException("Age > 0"); 
     age = value; 
    } 
} 

Answer 8

Я думаю, что важным принципом здесь является то, что вы последовательны. Используйте префикс «_» или «m», если это то, что вам нравится, и оно согласуется с остальной частью кода, с которым вы работаете. Что бы вы ни выбрали, придерживайтесь его и будьте последовательны.

Answer 9

Лучше всего использовать то, что уже используется в проекте. Если вы начинаете новый проект, используйте то, что чаще всего используется в компании.

Answer 10

Идентификаторы C++, начинающиеся с _, считаются плохой практикой, их следует оставить для внутреннего использования. Я думаю, именно поэтому префиксация имени переменной с помощью _ иногда считается плохой практикой в ​​C# ... хотя нет причин, по которым вы не можете этого сделать, поскольку все внутренние компоненты .NET инкапсулированы должным образом, в отличие от C/C++ стандартных библиотек.

Answer 11

Я предпочитаю символ подчеркивания как префикс для частных неконтактных полей без чтения. Зачем? Причины: 1. Просто взглянув на переменную, я могу различать поле & local/parameter variable. Использование «этого». для всех полей не вариант - его дольше. 2. Существует неоднозначность между параметром и поля:

class Foo 
{ 
    private int id; 
    public Foo(int id) 
    { 
    id = id; //Will compile and work fine. But field will not be initialized. 
    } 
} 

Answer 12

лично я всегда использовал свой первый пример:

public class Foo 
    { 
     private int _i; 
     private string _id; 
    } 

На самом деле, это то, что использует всю мою команду. Кроме того, тот, который вы упоминали m_dVal, известен как венгерская нотация, вот Wikipedia Entry. Венгерская нотация на самом деле противоречит стандартам кодирования наших команд, поэтому я никогда не использую ее.