Соглашения о написании кода предназначены для реализации следующих целей. Coding conventions serve the following purposes:
Создание согласованного вида кода, позволяющего читателям сосредоточиться на содержимом, а не на структуре. They create a consistent look to the code, so that readers can focus on content, not layout.
Предоставление читателям возможности делать предположения, основанные на опыте, и поэтому быстрее понимать код. They enable readers to understand the code more quickly by making assumptions based on previous experience.
Упрощение процессов копирования, изменения и обслуживания кода. They facilitate copying, changing, and maintaining the code.
Предоставление лучших методик C#. They demonstrate C# best practices.
Майкрософт использует приведенные в этом разделе рекомендации для разработки примеров и документации. The guidelines in this topic are used by Microsoft to develop samples and documentation.
Содержание
- Соглашения об именах Naming Conventions
- Соглашения о расположении Layout Conventions
- Соглашения о комментариях Commenting Conventions
- Рекомендации по работе с языком Language Guidelines
- Тип данных String String Data Type
- Неявно типизированные локальные переменные Implicitly Typed Local Variables
- Беззнаковый тип данных Unsigned Data Type
- Массивы Arrays
- Делегаты Delegates
- Операторы try-catch и using в процессе обработки исключений try-catch and using Statements in Exception Handling
- Операторы && и || && and || Operators
- Оператор New New Operator
- Обработка событий Event Handling
- Статический члены Static Members
- Запросы LINQ LINQ Queries
- Безопасность Security
- YouTube Premium
- Текст видео
Соглашения об именах Naming Conventions
В коротких примерах, не содержащих директив using, рекомендуется использовать полные указания для пространства имен. In short examples that do not include using directives, use namespace qualifications. Если известно, что пространство имен импортировано в проект по умолчанию, не требуется указывать полные имена из этого пространства имен. If you know that a namespace is imported by default in a project, you do not have to fully qualify the names from that namespace. Полные имена, если они слишком длинные для одной строки, можно разбить после точки (.), как показано в следующем примере. Qualified names can be broken after a dot (.) if they are too long for a single line, as shown in the following example.
Нет необходимости изменять имена объектов, созданных с помощью инструментов разработки Visual Studio, чтобы привести их в соответствие с другими соглашениями. You do not have to change the names of objects that were created by using the Visual Studio designer tools to make them fit other guidelines.
Соглашения о расположении Layout Conventions
Чтобы выделить структуру кода и облегчить чтение кода, в хорошем макете используется форматирование. Good layout uses formatting to emphasize the structure of your code and to make the code easier to read. Примеры и образцы корпорации Майкрософт соответствуют следующим соглашениям. Microsoft examples and samples conform to the following conventions:
Использование параметров редактора кода по умолчанию (логичные отступы, отступы по четыре символа, использование пробелов для табуляции). Use the default Code Editor settings (smart indenting, four-character indents, tabs saved as spaces). Дополнительные сведения см. в разделе "Параметры", "Текстовый редактор", C#, "Форматирование". For more information, see Options, Text Editor, C#, Formatting.
Запись только одного оператора в строке. Write only one statement per line.
Запись только одного объявления в строке. Write only one declaration per line.
Если отступ для дополнительных строк не ставится автоматически, необходимо сделать для них отступ на одну позицию табуляции (четыре пробела). If continuation lines are not indented automatically, indent them one tab stop (four spaces).
Добавление по крайней мере одной пустой строки между определениями методов и свойств. Add at least one blank line between method definitions and property definitions.
Использование скобок для ясности предложений в выражениях, как показано в следующем коде. Use parentheses to make clauses in an expression apparent, as shown in the following code.
Соглашения о комментариях Commenting Conventions
Комментарий размещается на отдельной строке, а не в конце строки кода. Place the comment on a separate line, not at the end of a line of code.
Текст комментария начинается с заглавной буквы. Begin comment text with an uppercase letter.
Текст комментария завершается точкой. End comment text with a period.
Между разделителем комментария (/ /) и текстом комментария вставляется один пробел, как показано в следующем примере. Insert one space between the comment delimiter (//) and the comment text, as shown in the following example.
Вокруг комментариев не должно быть звездочек. Do not create formatted blocks of asterisks around comments.
Рекомендации по работе с языком Language Guidelines
В следующих подразделах описаны методики, которыми руководствуется команда C# для подготовки примеров и образцов кода. The following sections describe practices that the C# team follows to prepare code examples and samples.
Тип данных String String Data Type
Для сцепления коротких строк рекомендуется использовать интерполяцию строк, как показано в следующем коде. Use string interpolation to concatenate short strings, as shown in the following code.
Для добавления строк в циклы, особенно при работе с текстами больших размеров, рекомендуется использовать объект StringBuilder. To append strings in loops, especially when you are working with large amounts of text, use a StringBuilder object.
Неявно типизированные локальные переменные Implicitly Typed Local Variables
В случаях, когда тип переменной понятен из правой части назначения или когда точный тип не важен, рекомендуется использовать неявное типизирование для локальных переменных. Use implicit typing for local variables when the type of the variable is obvious from the right side of the assignment, or when the precise type is not important.
Если тип из правой части назначения не является очевидным, не рекомендуется использовать var. Do not use var when the type is not apparent from the right side of the assignment.
При указании типа переменной не следует полагаться на имя переменной. Do not rely on the variable name to specify the type of the variable. Имя может быть неверным. It might not be correct.
Рекомендуется избегать использования var вместо dynamic. Avoid the use of var in place of dynamic.
Рекомендуется использовать неявное типизирование для определения типа переменной цикла в циклах for и foreach. Use implicit typing to determine the type of the loop variable in for and foreach loops.
В следующем примере неявное типизирование используется в операторе for . The following example uses implicit typing in a for statement.
В следующем примере неявное типизирование используется в операторе foreach . The following example uses implicit typing in a foreach statement.
Беззнаковый тип данных Unsigned Data Type
- Как правило, рекомендуется использовать int вместо беззнаковых типов. In general, use int rather than unsigned types. В C# обычно используется int . Использование int упрощает взаимодействие с другими библиотеками. The use of int is common throughout C#, and it is easier to interact with other libraries when you use int .
Массивы Arrays
При инициализации массивов в строке объявления рекомендуется использовать сокращенный синтаксис. Use the concise syntax when you initialize arrays on the declaration line.
Делегаты Delegates
Для создания экземпляров типа делегата рекомендуется использовать сокращенный синтаксис. Use the concise syntax to create instances of a delegate type.
Операторы try-catch и using в процессе обработки исключений try-catch and using Statements in Exception Handling
Рекомендуется использовать оператор try-catch для обработки большей части исключений. Use a try-catch statement for most exception handling.
Использование оператора C# using упрощает код. Simplify your code by using the C# using statement. При наличии оператора try-finally, код которого в блоке finally содержит только вызов метода Dispose, вместо него рекомендуется использовать оператор using . If you have a try-finally statement in which the only code in the finally block is a call to the Dispose method, use a using statement instead.
Операторы && и || && and || Operators
Чтобы избежать возникновения исключений и увеличить производительность за счет пропуска необязательных сравнений, рекомендуется использовать && вместо & и || вместо | при выполнении сравнений, как показано в следующем примере. To avoid exceptions and increase performance by skipping unnecessary comparisons, use && instead of & and || instead of | when you perform comparisons, as shown in the following example.
Оператор New New Operator
Рекомендуется использовать сокращенную форму создания экземпляра для объекта с неявным типизированием, как показано в следующем объявлении. Use the concise form of object instantiation, with implicit typing, as shown in the following declaration.
Предыдущая строка соответствует следующему объявлению. The previous line is equivalent to the following declaration.
Рекомендуется использовать инициализаторы объектов для упрощения создания объектов. Use object initializers to simplify object creation.
Обработка событий Event Handling
При определении обработчика событий, которого не требуется удалять позднее, рекомендуется использовать лямбда-выражение. If you are defining an event handler that you do not need to remove later, use a lambda expression.
Статический члены Static Members
- Для вызова статических членов следует использовать имя класса: ClassName.StaticMember. Call static members by using the class name: ClassName.StaticMember. В этом случае код становится более удобочитаемым за счет четкого доступа. This practice makes code more readable by making static access clear. Не присваивайте статическому члену, определенному в базовом классе, имя производного класса. Do not qualify a static member defined in a base class with the name of a derived class. Во время компиляции кода его читаемость нарушается, и если добавить статический член с тем же именем в производный классе, код может быть поврежден. While that code compiles, the code readability is misleading, and the code may break in the future if you add a static member with the same name to the derived class.
Запросы LINQ LINQ Queries
Используйте значимые имена для переменных запроса. Use meaningful names for query variables. В следующем примере используется seattleCustomers для клиентов, находящихся в Сиэтле. The following example uses seattleCustomers for customers who are located in Seattle.
Рекомендуется использовать псевдонимы для уверенности в том, что в именах свойств анонимных типов верно используются прописные буквы при помощи правил использования прописных и строчных букв языка Pascal. Use aliases to make sure that property names of anonymous types are correctly capitalized, using Pascal casing.
Переименуйте свойства, если имена свойств в результате могут быть неоднозначными. Rename properties when the property names in the result would be ambiguous. Например, если запрос возвращает имя клиента и идентификатор распространителя, не оставляйте имена в виде Name и ID , а переименуйте их, чтобы было ясно, что Name — имя клиента и ID — идентификатор распространителя. For example, if your query returns a customer name and a distributor ID, instead of leaving them as Name and ID in the result, rename them to clarify that Name is the name of a customer, and ID is the ID of a distributor.
Рекомендуется использовать неявное типизирование в объявлении переменных запроса и переменных диапазона. Use implicit typing in the declaration of query variables and range variables.
Выравнивайте предложения запроса под предложением from, как показано в предыдущих примерах. Align query clauses under the from clause, as shown in the previous examples.
Чтобы гарантировать, что более поздние предложения запроса работают с ограниченным, отфильтрованным набором данных, используйте предложение where перед другими предложениями запроса. Use where clauses before other query clauses to ensure that later query clauses operate on the reduced, filtered set of data.
Используйте несколько предложений from для доступа к внутренним коллекциям вместо предложения join. Use multiple from clauses instead of a join clause to access inner collections. Например, коллекция объектов Student может содержать коллекцию результатов тестирования. For example, a collection of Student objects might each contain a collection of test scores. При выполнении следующего запроса возвращаются результаты, превышающие 90 балов, а также фамилии учащихся, получивших такие оценки. When the following query is executed, it returns each score that is over 90, along with the last name of the student who received the score.
Безопасность Security
Следуйте указаниям, изложенным в правилах написания безопасного кода. Follow the guidelines in Secure Coding Guidelines.
1. Имя переменной должно начитаться с буквы.
2. Имя может быть любой длины.
3. Имя может содержать с себе буквы, цифры и любые символы пунктуации, кроме точки.
4. Учитывается регистр символов.
5. Нельзя использовать символы арифметических и логических операторов, а так же символы наподобие ‘#’ или пробела. Применение симваолов ‘$’ и ‘_’ допустимо, в том числе и в первой позиции имени.
6. Нельзя использовать зарезервированные слова.
В одной строке программы можно размещать несколько объявлений переменных. Однако, не рекомендуется следовать такому стилю. Считается, что если объявить каждую переменную в отдельной строке, читать программу становится легче.
Имя переменной не может совпадать с каким-бы то ни было идентификатором на данном уровне группировки. Это означает, что имена переменных не могут совпадать с именами меток других переменных на данном уровне группирования и параметров текущего метода. При объявлении переменной сначала указывается её тип, а замет её имя.
Перечень ключевых и зарезервированных слов в Java
Между Java программистами заключено соглашение Code Conventions for the Java Programming Language.
В этом соглашении есть пункты, касающиеся именования переменных:
1. Имена классов начинаются с прописной буквы. Если имя содержит несколько слов, то каждое слово начинается с прописной буквы.
2. Имена методов и переменных начинаются со строчной буквы. Если имя содержит несколько слов, то каждое следующее слово начинается с прописной буквы.
3. Имена констант записываются полностью прописными буквами. Если имя состоит из нескольких слов, то между ними ставится знак подчёркивания.
Область видимости переменных
В Java только один тип переменных – локальные переменные.
Время жизни переменной в Java определяется правилом:
Переменная создаётся в точке её описания и существует до момента окончания того блока, в котором находится данное описание.
В Java блок – это то, что начинается с открывающей фигурной скобки и заканчивается закрывающей фигурной скобкой.
Областью видимости переменной (scope) является фрагмент программы от точки её описания до конца текущего блока.
Область видимости – это статическое понятие, имеющее отношение к какому-то фрагменту текста программы. Время жизни, в отличие от области видимости, — это понятие динамики выполнения программы. Время жизни в Java совпадает с их областью видимости с учётом отличия самих этих понятий.
Если в блоке, где описана данная переменная, вложены другие блоки, то переменная доступна в этих блоках, что является обычной практикой программирования. В отличие от многих других языков в Java запрещено переопределять переменную во вложенных блоках, то есть описывать другую переменную с тем же именем.
Операции с числовыми аргументами
В Java допускается наличие цепочек присваивания.
Над вещественными числами могут выполняться операции сложения, вычитания, умножения и деления. Операция поиска остатка от деления недопустима.
Чтобы выполнить деление вещественных чисел следует убедиться, что одна из переменных или констант в выражении является вещественной.
Числа с плавающей точкой нельзя использовать в финансовых операциях, где ошибки округления недопустимы. Подобные ошибки связаны с внутренним двоичным представлением чисел. Подобно тому, как в десятичной системе счисления нельзя точно представить, например, одну третью, так и в двоичной системе счисления невозможно представить одну десятую. Чтобы исключить ошибки округления следует использовать класс BigDecimal.
Целочисленное деление на ноль генерирует исключение. В то же время результатом деления на ноль чисел с плавающей точкой может быть бесконечность или NaN.
Для обозначения констант в Java используется ключевое слово final.
Результат операции всегда принадлежит к тому типу данных, что и больший из операндов.
Преобразование типов данных в Java
При приведении типов данных меньшей длины к типам большей длины имеет место автоматическое преобразование типов (расширяющее преобразование) при условии совместимости двух приводимых типов.
При приведении типов данных большей длины к типам меньшей длины применяется приведение типов, которое иначе называется операция (тип). Где в качестве типа используется один из совместимых типов.
Синтаксически приведение типа задаётся парой скобок, внутри которых указывается желательный тип. Приведение логических значений к целым и наоборот невозможно.
Приоритет операций
Класс Math
Набор математических функций, которые часто оказываются необходимыми при решении задач содержит класс Math. В нём определены две константы: E и Pi.
Для статического импорта элемента класса Math в начале файла в виде import static java.lang.Math.* позволяет избежать префикса Math при обращении к константам и функциям класса Math в местах их вызова. Для вывода дробной части числа с определённым числом знаков после запятой используется метод printf.
Одномерные массивы
Массив – это набор однотипных элементов, на которые можно ссылаться по общему имени. Массивы можно создавать из элементов любого типа и они могут иметь одно или несколько измерений. Доступ к отдельному элементу массива осуществляется с помощью целочисленного индекса. В Java массивы являются объектами, но особого рода. Их объявление отличается от объявления других видов объектов. Переменная типа массив является ссылочной. В ней содержится адрес объекта, а не сам объект, как и для всех других объектных переменных в Java. В качестве элементов массива могут выступать значения, как примитивных типов, так и ссылочных типов, в том числе переменная типа «массив».
Формат объявления одномерного массива выглядит следующим образом.
Базовый тип определяет тип данных каждого элемента массива. Количество пар квадратных скобок указывает на размерность массива. Данный оператор только объявляет переменную a типа «массив», но не инициализирует её. Создание переменной типа «массив» не означает создание элементов этого массива. Такие переменные имеют объектный тип и хранят ссылки на объекты, однако, изначально имеют значение null.
Чтобы создать экземпляр массива нужно воспользоваться ключевым словом new. После чего указывается тип массива и в квадратных скобках указывается длина массива. Таким образом процесс создания массива включает 2 этапа, во первых, следует объявить переменную массива нужного типа, во вторых, необходимо выделить память, которая будет содержать массив, используя операцию new и назначить её переменной массива.
Как только выделена память для массива, можно обращаться к определённому элементу в нём, указывая в квадратных скобках индекс.
Нумерация элементов массива в Java начинается с нуля и пробегает всю длину массива до максимально допустимого значения, на единицу меньшего длины массива.
Возможно сочетание объявления переменной типа «массив» с выделением массиву памяти непосредственно в объявлении.
int[] a = new int[5];
Другой способ создания массивов – явная инициализация. В этом случае ключевое слово new не используется, а ставятся фигурные скобки, и в них перечисляются через запятую значения всех элементов массива. Длина массива вычисляется автоматически исходя из количества введённых значений. Далее создаётся массив такой длины и каждому его элементу присваивается указанное значение, при этом Java делает строгие проверки, чтобы удостоверится, что разработчик случайно не пытается сохранять или читать значения вне области хранения массива. Кроме того, исполнительная система Java так же выполняет проверки, чтобы убедиться, что все индексы находятся в нужном диапазоне.
Многомерные массивы
В Java многомерные массивы – это фактически массивы массивов. Они выглядят и действуют подобно обычным многомерным массивам.
Чтобы объявить многомерную переменную массива, нужно определить каждый дополнительный индекс, используя дополнительный набор квадратных скобок
int[][] twoD = new int[3][5];
Если создать двумерный массив и определить переменную x, которая на него ссылается, то используя x и два числа в паре квадратных скобок можно обратиться к любому элементу двумерного массива.
В то же время, используя переменную x и одно число в паре квадратных скобок, можно обратиться к одномерному массиву, который является элементом двумерного массива. Его можно инициализировать новым массивом с некоторой другой длиной. В результате таблица перестанет быть прямоугольной, а примет произвольную форму.
При создании многомерных массивов с помощью new необходимо указывать все пары квадратных скобок соответственно количеству измерений. Но заполненной обязательно должна быть только самая левая пара скобок, это значение задаст длину самого верхнего массива массивов.
Если заполнить следующую пару, то этот массив заполнится не значениями по умолчанию null, а новыми созданными массивами с меньшей на единицу размерностью.
Если заполнена вторая пара скобок, то можно заполнить третью и так далее.
Аналогично, для создания многомерных массивов можно использовать инициализаторы. В этом случае используется столько фигурных скобок, сколько требуется.
Из объектов массивов можно вызывать метод clone(), который позволяет создавать копию, или клон массива.
не приведёт к копированию массива. В этом случае переменная b станет ссылаться на тот же объект массив.
Копирование массивов можно выполнять в цикле, но значительно быстрее работает метод System.arraycopy().
Быстрое заполнение массива одинаковыми значениями может осуществляться методом
Для сортировки массива используется метод
Последнее изменение этой страницы: 2016-07-11; Нарушение авторского права страницы
Очередь просмотра
Очередь
- Удалить все
- Отключить
YouTube Premium
![]()
Хотите сохраните это видео?
- Пожаловаться
Пожаловаться на видео?
Выполните вход, чтобы сообщить о неприемлемом контенте.
Понравилось?
Не понравилось?
Текст видео
Паблик ВК https://vk.com/smplcode
Правила именования переменных https://vk.com/topic-142292681_35084452
В данном уроке мы узнаем что такое переменные, способы их объявления и правила именования.
✅Если вам нравятся мои уроки, вы хотите поддержать меня и развитие канала, то можете сделать это тут!=)
✅BTC кошелек: 12oYfJnvt76wjJbpvfhM41m6KPz6uz4LD4




