Тъй като настоящият текст е на български език, ще се опитаме да ограничим употребата на английски термини, доколкото е възможно. Съществуват обаче три основателни причини да използваме и английските термини наред с българските им еквиваленти:
-
По-голямата част от техническата документация за .NET Framework е на английски език (повечето книги и в частност MSDN Library) и затова е много важно читателите да знаят английския еквивалент на всеки използван термин.
-
Много от използваните термини не са пряко свързани с .NET и са навлезли отдавна в програмисткия жаргон от английски език (например "дебъгвам", "компилирам" и "плъгин"). Тези термини ще бъдат изписвани най-често на кирилица.
-
Някои термини (например "framework" и "deployment") са трудно преводими и трябва да се използват заедно с оригинала в скобки. В настоящата книга на места такива термини са превеждани по различни начини (според контекста), но винаги при първо срещане се дава и оригиналният термин на английски език.
С цел уеднаквяване на стила на кода във всички примери от книгата, в примерите и демонстрациите от лекциите, както и в практическия проект, е въведена конвенция за кода, която включва редица препоръки за форматирането на кода, имената на типове, членове и променливи, елементи от потребителския интерфейс и други. Ще обясним по-важните от тях:
Примери:
private const int MAX_VALUE = 4096;
private const string INPUT_FILE_NAME = "input.xml";
|
Това е утвърдена практика, възприета от повечето програмисти на C, C++, Java и C#.
Член-променливите пишем с префикс "m"
Примери:
private Hashtable mUsersProfiles;
private ArrayList mUsers;
|
Тази конвенция не е стандартна, но тъй като Microsoft нямат официална препоръка по този въпрос, ние възприехме тази конвенция за именуване на член-променливите, за да ги отличаваме от останалите променливи. Префиксът "m" произхожда от думата "member" (член).
Параметрите на методите пишем с префикс "a"
Пример:
public void IsLoginValid(string aUserName, string aPassword)
{
// ...
}
|
Тази конвенция също не е стандартна, но ние я възприехме, за да можем лесно да отличаваме параметрите в методите от останалите променливи, което често пъти е много полезно. Префиксът "a" произхожда от думата "argument" (аргумент на метод).
Възприели сме конвенция за именуване на идентификаторите, която е близка до официалните препоръки на Microsoft (за случаите, в които Microsoft са дали препоръки) и е съобразена с принципите за именуване на член-променливи и параметри, които вече разгледахме. Ето как изглежда тази конвенция:
Идентификатор
|
Стил
|
Пример
|
пространство от имена (namespace)
|
Pascal Case
|
System.Windows.Forms
|
тип (клас, структура, ...)
|
Pascal Case
|
TextWriter
|
интерфейс (interface)
|
Pascal Case, префикс "I"
|
ISerializable
|
изброен тип (enum type)
|
Pascal Case
|
FormBorderStyle
|
изброена стойност (enum value)
|
Pascal Case
|
FixedSingle
|
поле само за четене (read-only field)
|
Pascal Case
|
UserIcons
|
поле-константа (constant)
|
UPPERCASE
|
MAX_VALUE
|
свойство (property)
|
Pascal Case
|
BorderColor
|
събитие (event)
|
Pascal Case
|
SizeChanged
|
метод (method)
|
Pascal Case
|
ToString()
|
член-променлива (field)
|
Pascal Case, префикс "m"
|
mUserProfiles
|
статична член-променлива (static field)
|
Pascal Case, префикс "m"
|
mTotalUsersCount
|
параметър на метод (parameter)
|
Pascal Case, префикс "a"
|
aFileName
|
локална променлива (local variable)
|
Camel Case
|
currentIndex
| Именуване на контроли
При именуване на контроли използваме Pascal Case и представка, която съответства на техния тип. Не слагаме префикс "m", когато контролата е член-променлива:
Контрола
|
Пример
|
Button
|
ButtonOk, ButtonCancel
|
Label
|
LabelCustomerName
|
TextBox
|
TextBoxCustomerName
|
Panel
|
PanelCustomerInfo
|
Image
|
ImageProduct
| Конвенции за базата данни
Използваме множествено число за именуване на таблици (например Users, Countries, StudentsCourses, …). При имената на колоните в таблица използваме Pascal Case (например UserName, MessageSender, UserId и т.н.).
Служебните думи в езика SQL (например SELECT, CREATE TABLE, FROM, INTO, ORDER BY и др.) изписваме с главни букви.
Сподели с приятели: |