Соглашения об именах для элементов управления - PullRequest
2 голосов
/ 02 января 2011

При работе с VS по умолчанию редактор генерирует это:

<asp:Button ID="Button1" runat="server" Text="Button" />

Теперь сгенерированный идентификатор - Button1, т.е. заглавная буква.Мои вопросы: как лучше назвать элементы управления?

  • SubmitButton

  • btnSubmit

или что-то еще?

Какое соглашение об именах считается хорошим?

Ответы [ 4 ]

8 голосов
/ 02 января 2011

btnSubmit - это венгерская нотация, которую я лично не считаю хорошей для программирования пользовательского интерфейса, поскольку тип элемента управления очевиден непосредственно через его объявление или intellisense в Visual Studio.

SubmitButton лучше. Обычно это принимает форму - Purpose-TypeOfControl

Например

InputLabel
FirstNameLabel
LastNameLabel
CancelButton

Это хорошая ссылка: http://10rem.net/articles/net-naming-conventions-and-programming-standards---best-practices

Обновление: венгерские обозначения также не рекомендуется использовать stylecop / Fxcop. Так что лучше не использовать полностью.

1 голос
/ 02 января 2011

Суть соглашения заключается в том, что это то, что разделяют другие разработчики в вашей команде и те, которые могут присоединиться к команде позже.Хотя хорошо, что вы можете читать свой собственный код 6 месяцев, год, два года спустя, еще более важно, чтобы другие могли читать ваш код, когда вы переходите в другой проект.Поэтому, пока идут споры о том, какое соглашение является наиболее полезным / читабельным, важно убедиться, что оно применяется во всей команде, и что у новых членов команды есть разумный шанс понять его, когда они внесены на борт.Венгерский может быть не очень красивым или читабельным, но он очень распространен, и мы все с ним знакомы, даже если нам это не нравится!

1 голос
/ 02 января 2011

Причина номер один - удобочитаемость . Имена должны быть читаемыми, а SubmitButton гораздо более читабельным, чем btnSubmit.

Стиль btnSubmit называется венгерской нотацией. Одна из проблем заключается в том, что вам приходится изобретать префиксы для нового типа создаваемого вами элемента управления. Например, если вы создаете пользовательский элемент управления с именем StocksTrendPlotter, у вас должны быть такие переменные, как stpGraph, которые трудно читаемые.

Проверьте недостатки венгерской нотации.

0 голосов
/ 02 января 2011

Префикс "ux" или "ui" - это обычное обозначение, поскольку он хорошо группирует все элементы управления пользовательского интерфейса в intellisense.Также полезно удалить любые указания для типа элемента управления (например, кнопки) из именования, если вы поменяете типы элементов управления на более позднем этапе, например, uxSalutation, который может измениться с текстового поля на комбинированный список с ограниченным воздействием.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...