Главная - Литература

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 [87] 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294

объектов начинаются со строчной буквы, а имена методов - с прописной: variable-Name, но RoutineNameQ.

Проведите различие между классами и объектами Соответствие между именами классов и объектов (или между именами типов и переменных этих типов) может быть довольно тонким. Некоторые стандартные способы проведения различия между ними иллюстрирует следующий фрагмент:

Вариант 1: имена типов отличаются от имен переменных регистром первой буквы

Widget widget; LongerWidget longerWidget;

Вариант 2: имена типов отличаются от имен переменных регистром всех букв

WIDGET widget; LONGERWIDGET longerWidget

Вариант 3: имена типов дополняются префиксом «t »

t Widget Widget; t LongerWidget LongerWidget;

Вариант 4: имена переменных дополняются префиксом «а»

Widget aWidget; LongerWidget aLongerWidget;

Вариант 5: имена переменных более конкретны, чем имена типов

Widget employeeWidget; LongerWidget fullEmployeeWidget;

Каждый из этих вариантов имеет свои плюсы и минусы. Вариант 1 часто используется при программировании на С++, Java и других языках, чувствительных к регистру букв, но некоторые программисты считают, что различать имена только по регистру первой буквы неудобно. Действительно, имена, отличающиеся только регистром первой буквы, имеют слишком малое психологическое и визуальное различие.

Вариант 1 не удастся согласованно использовать при программировании на нескольких языках, если хотя бы в одном из них регистр букв не имеет значения. Так, при компиляции команды Dim widget as Widget компилятор Microsoft Visual Basic сообщит о синтаксической ошибке, потому что widget и Widget покажутся ему одним и тем же элементом.

Вариант 2 проводит более очевидное различие между именами типов и переменных. Однако по историческим причинам в С++ и Java верхний регистр служит для определения констант, к тому же при разработке программы с использованием нескольких языков этот подход приводит к тем же проблемам, что и вариант 1.

Вариант 3 поддерживается всеми языками, но некоторым программистам префиксы не нравятся по эстетическим причинам.

Вариант 4 иногда используют как альтернативу варианту 3, но вместо изменения имени одного класса он требует модификации имени каждого экземпляра класса.



Вариант 5 заставляет тщательно обдумывать имя каждой переменной. Обычно результатом этого является более понятный код. Но иногда widget (приспособление) на самом деле - всего лишь общее «приспособление», и в этих случаях вы должны будете придумывать менее ясные имена вроде genericWidget, которые, несомненно, читаются хуже.

Короче, каждый из вариантов связан с компромиссами. В этой книге я использую вариант 5, потому что он наиболее понятен, если человеку, читающему код, неизвестны конвенции именования.

Идентифицируйте глобальные переменные Одной из частых проблем программирования является неверное использование глобальных переменных. Если вы присвоите всем глобальным переменным имена, начинающиеся, скажем, с префикса g , программист, увидевший переменную gRunningTotal, сразу поймет, что это глобальная переменная, и будет обращаться с ней должным образом.

Идентифицируйте переменные-члены Идентифицируйте данные-члены класса. Ясно покажите, что переменная-член не является ни локальной, ни глобальной переменной. Идентифицировать переменные-члены класса можно, например, при помощи префикса т .

Идентифицируйте определения типов Конвенции именования типов играют две роли: они явно показывают, что имя является именем типа, и предотвращают конфликты имен типов и переменных. Для этого вполне годится префикс (суффикс). В С++ для именования типов обычно используют только заглавные буквы: например, COLOR и MENU. (Это справедливо для имен типов, определяемых с помощью директив typedef и имен структур, но не классов.) Однако при этом можно спутать типы с именованными константами препроцессора. Для предотвращения путаницы можно дополнять имена типов префиксом t , что дает нам такие имена, как tjColor и t Menu.

Идентифицируйте именованные константы Именованные константы нужно идентифицировать, чтобы вы могли определить, присваиваете ли вы переменной значение другой переменной (которое может изменяться) или именованной константы. В случае Visual Basic эти два варианта можно также спутать с присваиванием переменной значения, возвращаемого функцией. Visual Basic не требует применения скобок при вызове функции, не принимающей параметров, тогда как в С++ скобки нужно указывать при вызове любой функции.

Одним из подходов к именованию констант является применение префикса, например с . Это дает нам такие имена, как cRecsMax или cLinesPerPageMax. В случае С++ и Java конвенция подразумевает использование только заглавных букв без разделения слов или с разделением слов символами подчеркивания: RECSMAX или RECS МАХ и UNESPERPAGEMAX или UNES PER PAGE МАХ.

Идентифицируйте элементы перечислений Элементы перечислений следует идентифицировать по той же причине, что и именованные константы: чтобы элемент перечисления можно было легко отличить от переменной, именованной константы или вызова функции. Стандартный подход предполагает применение в имени перечисления только заглавных букв или дополнение имени префиксом е или что касается имен элементов, то они дополняются префиксом, основанным на имени конкретного перечисления, скажем, Со1ог или Planet .



Идентифицируйте неизменяемые параметры, если язык не требует их явного определения Иногда программисты случайно изменяют входные параметры. С++, Visual Basic и некоторые другие языки заставляют явно указывать, хотите ли вы, чтобы изменения параметров внутри метода были доступны в остальном коде. Для этого служат спецификаторы *, в- и const в С++ и ByRef/ByVal в Visual Basic.

В случае других языков изменение входной переменной в методе отражается в остальном коде, хотите вы того или нет. Это особенно верно при передаче объектов. Например, в Java все объекты передаются в методы «значением», поэтому, передавая объект в метод, будьте готовы к тому, что состояние объекта может измениться (Arnold, Gosling, Holmes, 2000).

Если, программируя на таком языке, вы следуете конвенции щщщ Дополие-именования, согласно которой исключительно входные ние языки конавнцией йШйОва-(неизменяемые) параметры нужно дополнять префиксом цшлmmmщщmttщmh const (или final, или nonmodifiable, или каким-то аналогич- нш шот языка, являешя при* ным), то, увидев что-то с префиксом const слева от знака мерам программирована с неравенства, вы будете знать, что произошла ошибка. Если вы jJJJJ увидите вызов constMaxSetNewMax( вы также по префиксу дщ ji разда ЫЛ). const поймете, что это ошибка.

Форматируйте имена так, чтобы их было легко читать Для повышенР1я удобочитаемости кода слова в именах переменных часто разделяют заглавными буквами или символами-разделителями. Например, имя GYMNASTICSPOINTTOTAL читается хуже, чем gymnasticsPointTotal или gymnasticsJ)oint totaL С++, Java, Visual Basic и другие языки позволяют использовать оба этих подхода.

Старайтесь не смешивать эти способы, так как это осложняет чтение кода. Если же вы будете согласованно использовать один из подходов, код станет более понятным. Программисты уже давно спорят по поводу того, делать ли заглавной первую букву имени (TotalPoints или totalPoints), но если все участвующие в проекте программисты будут поступать согласованно, подобные мелочи не будут играть особой роли. В данной книге имена переменных начинаются с буквы нижнего регистра по той причине, что этот подход принят в языке Java, а также для поддержания сходства стилей между разными языками.

Конвенции, специфические для конкретных языков

Соблюдайте конвенции именования, принятые в используемом вами языке. Книги по стилю программирования можно найти почти для любого языка. Советы, относящиеся к языкам С, С++, Java и Visual Basic, даны в следующих подразделах.

Конвенции С

Конвенции именования, используемые при программировании на С, предполагают, что:

имена символьных переменных дополняются префиксом с или сЬ;

целочисленным индексам присваиваются имена / и У;

Значением передается ссылка на объект, который и может быть изменен. - Прим. перев. 10-403



0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 [87] 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294



0.0102