обобщение документ
"Унгарското споразумение" за имената на идентификатори Чарлз Симони.
Обърнете внимание, от д-р. GUI
Дори по време на разработването на първата версия на DOS, д-р Чарлз Симони въвежда конвенцията за именуване на идентификатори, в които да определят функционалното предназначение на обекта, представлявана от който се прилага, за да добавите префикс на името на идентификатора.
Унгарската нотация е една от техниките, които позволяват на програмистите да създават по-четлив код за кратко време. В повечето от файловете на документация и заглавни, издадени от Microsoft да използва унгарската нотация в последните 15 години. Много програмисти извън Microsoft приемат това споразумение или друга подобна схема за генериране на имена на идентификатори.
Може би най-важните публикации, популяризиращи унгарската нотация е първата книга чете почти всеки Windows - програмист: "Windows programmin" Чарлз Петзолд. В това споразумение книгата използва за Примери и бележки и е описана накратко в първата глава.
Този документ е оригиналната версия на работата Симони.
Споразумение за идентификатори в програмата.
Този документ има за цел да очертае основните предимства на официално формирането на идентичност.
С въвеждането на нова идентификатор в програмата, е добър програмист взема предвид следните фактори:
- мнемоничен стойност. ID трябва да бъде лесен за запомняне
- което означава. ID роля трябва да е ясно от името му
- приемственост. Често се разглежда като чисто естетическа идея, но все пак подобни обекти трябва да имат подобни документи за самоличност.
- скорост решение. изобретяваме, запис и редактиране идентификатор не трябва да отнеме твърде много време, идентификаторът не трябва да бъде прекалено дълго.
Изборът на име може да бъде задача на абсорбиране твърде много време от строителя. ID често отговарят на едно противоречие други условия. В допълнение, за да се поддържа непрекъснатостта на имената понякога е доста трудно.
Ползи споразумения
Тези споразумения идентификатори предоставя удобен метод за образуване на имена, които отговарят на горепосочените критерии. Основната идея е за прехвърляне на основните характеристики на идентификатора, като част от името му. Тази проста идея, разбира се, има нужда от разяснения (което, например, се разбира под "критерият за" какво да се прави, ако те (критерии) не са уникални?). Все пак, нека първо да постановява общите разпоредби.
Мнемонични имена ще бъдат в много специфичен смисъл: идентификаторът ще бъде очевидно за този, който си спомня името на характеристиките или принципите на неговото изграждане.
Имената имат значение: трябва да има възможност да се покаже всяко име в набор от характеристики.
Имената ще бъдат съобразени, както са произведени от едни и същи правила.
Имената на сградата ще бъдат произведени механично, толкова бързо.
Изразите в програмата могат да бъдат проверени за непрекъснатост по методи, подобни на обичайните свойства на обекта на измерване.
именуване на права
Следните правила за обозначаване: 1) Описание на характеристиките идентификатор включени в идентификатор. Пунктуацията е удобно да се определят характеристиките на предната част на името, с разделението на (име започва с главна буква в C, например: rowFirst: ред - характеристика, Fist - име).
2) Заглавие изтъкнати идентификатори, имащи същия вид и съществуващи в същия контекст. Контекстът може да бъде системата като цяло и процедура за единица, структурата на данните в съответствие с програмната среда. Ако има име по подразбиране, то трябва да се използва. Изборът трябва да бъде толкова просто, тъй като тя изисква идентификатор уникален само в определен контекст.
3) Простите типове наречените къси тагове, които са избрани от програмист. Тези маркери трябва да са интуитивни за повечето програмисти.
Маркерът трябва да бъде кратък, за да се постигне четвъртото условие (Фактор), ние въведохме по-горе. Имена на видовете трябва да включват имената на компонентите. Има стандартни схеми на показалеца и масива. Други типове данни могат да се определят произволно. Напр р представка се използва за стрелките. По принцип споразумение може да се обогати в съответствие с новите видове на схема за данни. Въпреки това, стандартен дизайн може да служи за дълго време. Трябва да се отбележи, че структурата на областта не трябва да участва във формирането на префикса, тъй като в този случай, изграждането на повече от две области, които не са просто за четене. По-важното при предаването на префикса на същността й структурата не зависи от набор от области, както и метода на неговото използване.
Аз препоръчвам да използвате нов маркер за всеки нова структура на данните. Маркиране с определен пунктуация (първи или с главни букви) и може да се използва като име на тип структура. Използването на новите маркери като оправдано в случаите, когато това се отразява на четливостта на програмата.
Моят опит е, че етикетите са по-трудни, за да изберете от имената. Когато необходимостта от нов маркер, първи инстинкт е да се използва по-кратки, описателни, общи и универсални условия, името на този тип. Това е - почти винаги е грешка. Вие не можете да направите резервно копие на най-полезните термини и изрази за лично ползване на конкретна задача или дори версия. Обикновено всеки универсален термин е еднакво приложим както за много видове, дори и в една и съща програма.
Имайте предвид, че, като правило, очевидният избор за името, е най-правилното. Причината за това е, че името трябва да бъде уникален в рамките на много по-малък в сравнение с контекста на маркера. Както подсказва името, като правило, не участват във формирането на други имена, те не трябва да бъдат особено кратко.
Например, ние се създаде графичен програма. В този случай, ние имаме тип данни на "цвят". Естественото желание е да се направи цвета префикс за идентифициране на цвят. Въпреки това, по-внимателно вглеждане може да се окаже, че използването на термина цвят е по-удобно в приложението към името, например: LineColor. За обозначаване на цвета по-изгодно е да се намали, например CLR. clrDefault.
Определяне за по-лесно писане.
Правилното формиране на идентификатори трябва да позволи на няколко програмисти самостоятелно да създават програма за решаване на даден проблем. Всеки програмист трябва да знае правилата за именуване, в противен случай ще бъде невъзможно да се организира взаимодействието. Такъв експеримент е безполезна, когато обмислят голям проект, но е ясна цел. Резултатът е способността да се разбере и да се коригира програмата, написана от друг човек. Този резултат се постига с договори obscheopredelennyh правилна употреба. Ето защо на процеса на документиране на маркера е много важно.
Обозначението за процедурите.
За съжаление, просто концепцията на квалифициран отпечатан етикет не работи за името на процедурата. Някои процедури не получават параметри или стойности за връщане. Контексти процедури имена са склонни да бъдат големи. В следващия набор от специални правила за процедурите могат да работят доста задоволително:
1) Имената на процедури трябва да се различават от другите имена пунктуационни, например, винаги се започва с главна буква (докато тагове характеристики други идентификатори са написани с малки букви).
2) Започнете името на процедурата с типа маркер на върнатата стойност, ако има такива.
3) Да се посочат процедурите за работа в една или две думи. Думи трябва да бъдат отделени от пунктуацията четец за по-лесно анализ (конвенционален метод е да се използва главни инициали за всяка дума).
4) В края на името, можете да добавите в списъка на таговете на всички или някои от формалните параметри, ако това има смисъл.
Последната точка в противоречие с по-ранни забележки по отношение на описанието на структурата на данните. Ако параметрите на процедурата са се променили, но и ще промени името на всички точки на процедура повикване. Въпреки това, такава промяна може да се използва, за да се увери, че всички точки на процедурата по модифициран повикване ще бъде изпълнена правилно. В случай на структурите от данни, добавянето или промяната на областта не са от решаващо значение за използването на типа на данните. Ако процедурата има един или два параметъра, с използването на етикети ще улесни избора на името.
Таблица 1. Някои примери за имена за процедурата
Свързани статии