Имена переменных




Скачать 40.41 Kb.
НазваниеИмена переменных
Дата публикации14.08.2013
Размер40.41 Kb.
ТипДокументы

Const

Стандарты написания C# кода

В asp.net приложении




Const

10/20/2010



Чернявский Константин const.miyang@gmail.com


Оглавление


Имена переменных. 2

Имена методов. 2

Имена классов, событий, делегатов. 3

Структура файла. 3

Структура классов. 4

Структура методов. 4

Структура блоков. 4

Структура asp.net странички. 5


Имена переменных.


  1. Имена переменных не должны содержать _ (символа подчеркивания). Возможно, такой код удобочитаем, но неудобен для написания.

  2. Имена public переменных и входящих параметров должны быть в Pascal case.

  3. Имена внутренних protected и private переменных должны быть в Camel case.

  4. Логические части имен переменных должны разделяться регистром, пример, UserName.

  5. Ключ (ID), пишется всегда заглавными или строчными буквами, пример, UserID (public), userID (private), ID (public), id (private). Но не UserId, userId, Id, iD. Тоже относится к подобным словам, пример, IP.

  6. Если класс содержит public свойство Name, то переменная хранения значения должна быть name, но не _name или nm, или еще что-то в этом роде.

  7. Имена переменных должны быть написаны полностью, без сокращений. Пример, class User, property Password, но не pswd.

  8. Переменные, которые видно только в пределах одного метода, можно и даже нужно сокращать, пример, DataRow row, FileInfo fi, HtmlTableCell cell, StreamReader sr. Исключением, является случай, когда метод слишком большой, тогда имена переменных тоже стоит писать полностью.

  9. Переменная, которая возвращается методом, должна называться result.


Имена методов.


  1. Имена методов должны придерживаться того же принципа, что и имена переменных.

  2. Исключение в именах методов. Имена обработчиков событий должны состоять из двух частей: имя объекта и имя события, разделенных между собой _ (символом подчеркивания).

  3. По возможности избегать размножения методов с разными именами, а пользоваться полиморфизмом. Пример, метод GetUser(long UserID) и метод GetUser(string UserLogin), но не методы GetUserByID(long UserID), GetUserByLogin(string UserLogin).

  4. Методы выборки, возвращающие таблицу или массив любых других значений должны начинаться с ключевого слова Select. Методы для получения скалярного значения или одной записи должны начинаться со слова Get. Для обновления – Update (не Edit). Для удаления – Delete (не Remove). Вставки – Insert (не Add или New).


Имена классов, событий, делегатов.


  1. Имена классов должны начинаться с большой буквы, не зависимо, от того, какой у него уровень доступа.

  2. Классы наследники ключевых классов должны содержать в конце имя класса предка, пример, MyException, MyEventAgrs, MyDataSet. Но если есть класс MyClass и MySecondClass : MyClass, то в конце MySecondClass добавлять MyClass, конечно, не надо.

  3. То же относится к делегатам и обработчикам событий. MyDelegate, MyEventHandler, но не DelegateMy или EventHandlerMy.

  4. Имена событий, так и называются, без каких либо добавлений, пример, Sorting, Uploaded, но не OnSorting, OnUploaded или EventSorting, SortingEvent.


Структура файла.


  1. Все using надо выносить из namespace блока. Using писать в следующем порядке – системные (System), сторонние компоненты, собственные.


Структура классов.


  1. Перечисления (enum), события и делегаты, должны располагаться в самой верхушке.

  2. Все переменные класса, будь то public или private, должны находиться на втором месте. Которые в свою очередь должны быть отсортированы в порядке доступа – private, protected, public. Static переменные идут спереди, не зависимо от модификатора доступа.

  3. Сразу после переменных должны располагаться конструкторы и деструкторы.

  4. После конструкторов, идут свойства.

  5. После свойств методы.

  6. Static методы располагаются в самом низу, в отдельном region.

  7. Если класс большой, каждый из блоков, можно и даже нужно, выделить в отдельный region.

  8. Если класс использует другой, вспомогательный и при этом маленький класс, его описание можно поместить под главным классом, в этом же файле. Но это не желательно. Пример, какой-то comparer.


Структура методов.


  1. Все переменные, используемые методом, должны быть объявлены в самом верху. Если переменная не нужна во всем методе, а используется только в каком-то незначительном сценарии, она все равно должна быть объявлена вместе со всеми. А инициализирована, уже там, где надо.

  2. По возможности избегать большого количества точек выхода из метода.

  3. Если метод возвращает значение, которое возвращает другой метод, создавать промежуточную переменную result. Если же метод не выполняет никаких операция, а только перенаправляет запрос, промежуточная переменная не обязательна.


Структура блоков.


  1. Не использовать сокращенный вариант блоков. Пример if(!IsValid) { return; }, но не if(!IsValid) return; Особенно избегать конструкций типа if(Value) for(int i = 0; i < 10; i++) { do something… }. Блок for выходит за рамки одной строчки, но входит в блок if, который не ограничен скобками. Очень неудобно для чтения.

  2. Переносить на новую строку блок, даже если в блоке всего одна строчка. Пример if(!IsValied) \n {\n return; \n }, но не if(!IsValid) { return; }. Тоже касается и свойств, пример, get \n { \n return myVal; \n }, но не get { return myVal; }.

  3. Избегать использования больших using, блоков, а вызывать метод Dispose(), самостоятельно.


Структура asp.net странички.


  1. Имена всех элементов, которые хоть как-то используются на серверной части должны иметь 2-х или 3-х буквенный префикс, но не постфикс. Пример txtEmail, но не EmailTextBoxt.

    1. Literal – ltr

    2. TextBoxt – txt

    3. HiddenField – hdn

    4. CheckBox – chb

    5. RaioButton – rbt

    6. Button – btn

    7. LinkButton – btn

    8. ImageButton – btn

    9. Image – img

    10. DropDownList – ddl

    11. Panel – pnl

    12. Table – tbl

    13. …DataSource – ds

    14. GridView – grd

    15. ListView – lst

    16. DetailsView – dv

    17. DataList – dl

    18. FormView – fv

    19. Repeater – rpt

    20. ScriptManager – scm

    21. UpdatePanel – upn

    22. Times – tmr

  2. Имена html control так же должны начинаться с префиксов, если они используются на серверной части или в js коде, пример, divButtons, aObjectLink, h2Header, spnErrorText.

  3. Если свойство runat установлено в true и данный control должен быть доступен из js, то CssClass должен содержать id элемента.

Добавить документ в свой блог или на сайт

Похожие:

Имена переменных iconЗадача g6 1001: Проблема с a и B
Поменять значения переменных a и b между собой, не заводя дополнительных переменных. Входной файл input txt содержит числа a и b...

Имена переменных iconЗадача а (стр. 27)
Составив таблицу истинности для каждого из «кандидатов на равносильность», проверим, являются ли тождественно истинными высказывания...

Имена переменных iconМероприятия, посвященные Дням памяти святого благоверного князя Александра...
У каждого народа есть заветные имена, которые никогда не забываются, напротив, чем дальше развивается историческая жизнь народа,...

Имена переменных iconАнализ текста «Географическое название»
Имена рек – старейшины в мире географических названий; я имею при этом в виду имена больших, самых прославленных рек Земли

Имена переменных iconБертран Рассел Брак и мораль
В историю xx в навсегда войдут не только имена политиков, диктаторов и полководцев, но и имена великих ученых, философов и писателей....

Имена переменных iconЗа отчетный пе­риод, умноженной на нормативную ставку переменных накладных расходов
Роздел четвертый. Информация для планирования, управления и измерения показателей функционирования

Имена переменных iconМетодические указания по выполнению контрольной работы за 2 семестр по дисциплине «информатика»
«Использование средств Excel для исследования функции от двух переменных и решения задачи линейного программирования»

Имена переменных iconСоздание надежных тестов: личностные опросники, разработка заданий
Однако, в силу природы личностных переменных, труднее всего бывает установить валидность именно этих методик

Имена переменных iconВопросы к зачету
Погрешности вычислений. Устойчивость и сложность алгоритма (по памяти, по времени). Организация вычислений на примерах жордановых...

Имена переменных icon2. логические элементы
К комбинационной логике относятся ис, элементы которых не обладают памятью, т е выходной сигнал определяется только комбинацией входных...

Вы можете разместить ссылку на наш сайт:
Школьные материалы


При копировании материала укажите ссылку © 2013
контакты
vbibl.ru
Главная страница