VB.NET Как вы называете свои переменные, которые относятся к их типу? - PullRequest
3 голосов
/ 12 июля 2011

Просто интересно, что каждый использует для именования переменных, которые относятся к уже описательному классу?

Например:

Dim customersData as New CustomersData
Dim customersCollection as CustomersCollection
customersCollection = customersData.GetAll()

Кажется, что ни одно из указанных выше правил не подходит в C #, но не рекомендуется в VB (хотя оно будет прекрасно компилироваться). Я видел префиксы типа 'o '(oCustomersData), а также' my '(myCustomersData), но я не уверен, что мне нравится, что я тоже видел аббревиатуры, такие как cd & cc, аргумент, что все, что вам нужно сделать, это навести курсор на переменную, чтобы увидеть тип, но этосерьезно повреждает самодокументирование и читабельность.

Что вы думаете о людях?

Ответы [ 2 ]

4 голосов
/ 12 июля 2011

Я бы, наверное, пошел с:

Dim custData as New CustomersData 'Better name might be CustomersDataService
Dim customers as CustomersCollection
customers = custData.GetAll()

Назовите переменные по их значению в текущем контексте: Другой пример может быть.

Dim excludedCustomers as CustomersCollection
excludedCustomers = custData.GetExcluded()
3 голосов
/ 12 июля 2011

Я бы написал так:

Dim customersData As New CustomersData
Dim customers As CustomersCollection
customers = customersData.GetAll()

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

For each customer In customers
    ....
Next

Не рекомендуется в VB (хотя он прекрасно скомпилируется)

Я не видел такого совета раньше, и я все время использую этот метод.

Я видел префиксы типа 'o' (oCustomersData), а также 'my' (myCustomersData), но я не уверен, что мне тоже нравится.

Я никогда не префиксирую переменные, подобные этой. Единственные переменные, которые я префикс, это переменные класса с _; например _customers

Я также видел сокращения, такие как cd & cc, аргумент, что все, что вам нужно сделать, это навести курсор на переменную, чтобы увидеть тип, но это серьезно повредит самодокументированию и читабельности.

Вы предоставили ответ. Нет необходимости, и это ухудшает читабельность, чтобы использовать короткие имена переменных, подобные этому. Если аргументом для использования коротких имен переменных является скорость печати, я бы поспорил научиться правильно печатать и использовать intellisense.

...