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

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

Классичаохой книгой о стиле программирование на О является «О Programming 0ujdelJne$» {Plum, 1984).

имена переменных, хранящих количество чего-либо, дополняются префиксом п;

Ш имена указателей дополняются префиксом р; Ш имена строк начинаются с префикса s; Ш имена макросов препроцессора включают ТОЛЬКОЗАГ-ЛЛВНЫЕ БУКВЫ; обычно это правило распространяется и на имена типов, определяемых при помощи директивы typedef, т имена переменных и методов включают только строчные буквы-, Ш для разделения слов служит символ подчеркивания ( ): имена такого вида читаются легче, чем именатакоговида.

Эти правила справедливы для программирования на С в общем, а также для сред UNIX и Linux, однако в разных средах конвенции имеют свои особенности. Программисты на С, разрабатывающие программы для Microsoft Windows, предпочитают применять для именования переменных ту или иную форму венгерской нотации и буквы верхнего и нижнего регистров. Программисты, разрабатывающие ПО для платформы Macintosh, обычно используют для именования методов смешанный регистр, потому что инструментарий Macintosh и методы ОС были изначально разработаны в соответствии с интерфейсом Pascal.

Конвенции С++

Доноишельше сведения О

стиле программировшив на 0+ см. книгу «The Elements of 0+ Style» (MIsfeldt, Bumgarte, md Gray. 2004).

C программированием на С++ связаны такие конвенции:

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

имена указателей дополняются префиксом р; Ш имена констант, типов, определяемых с помощью директивы typedef, и макросов препроцессора включают ТОЛЬКО-ЗАГЛАВНЫЕ БУКВЫ,

Ш имена классов и других типов содержат БуквыОбоихРегистров-,

первое слово в именах переменных и методов начинается со строчной буквы, а все последующие слова - с заглавной: имяПеременнойИлиМетода-,

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

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

Конвенции Java

iCM.

тщ «Tlie Stemants of Java Style, 2d ed.» <Vermeulen at al., 2000).

В отличие от С и С++ конвенции стиля программирования на Java были сформулированы уже на ранних этапах развития этого языка:

Itwj - имена целочисленных индексов; имена констант включают ТОЛЬКО ЗАГЛАВНЫЕ БУКВЫ, а слова разделяются символами подчеркивания;



все слова в именах классов и интерфейсов начинаются с заглавной буквы: ИмяКлассаИлиИнтерфейса\

в именах переменных и методов с заглавной буквы начинаются все слова, кроме первого: имяПеременойИлиМетода\

символ подчеркивания служит разделителем только в именах, полностью состоящих из заглавных букв;

имена методов доступа начинаются с префикса get или set.

Конвенции Visual Basic

Устойчивых конвенций стиля программирования на Visual Basic не существует. Чуть ниже я приведу один из возможных вариантов.

Программирование с использованием нескольких языков

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

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

Примеры конвенций именования

в стандартных конвенциях, описанных выше, не отражены некоторые важные аспекты, в том числе область видимости переменных (закрытая, класс или глобальная), различия имен классов и объектов, методов и переменных и т. д.

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

суть переменной (то, что переменная представляет);

тип данных (именованная константа; элементарная переменная; тип, определенный пользователем, или класс);

область видимости переменной (закрытая, класс, пакет или глобальная область видимости).

В табл. 11-3, 11-4 и 11-5 описаны конвенции именования для языков С, С++, Java и Visual Basic, основанные на уже известных вам принципах. Использовать именно эти конвенции не обязательно, однако они помогут вам понять, что может включать неформальная конвенция именования.



Табл. 11 -3. Пример конвенции именования для языков С++ и Java

Сущность

Описание

ClassName TypeName

EnumeratedTypes localVariable

routineParameter

RoutineNameQ

mjClassVariable

g GlobalVariable CONSTANT

MACRO

BaseEnumeratedType

Имена классов начинаются с заглавной буквы и включают буквы обоих регистров.

Имена типов, в том числе перечислений и типов, определяемых при помощи директив typedef, начинаются с заглавной буквы и включают буквы обоих регистров.

Кроме предыдущего правила, имена перечислений всегда имеют форму множественного числа.

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

Имена параметров методов форматируются так же, как имена локальных переменных.

Имена методов включают буквы обоих регистров (об удачных именах методов см. раздел 7.3).

Имена переменных-членов, доступных только методам класса, дополняются префиксом т .

Имена глобальных переменных дополняются префиксом g .

Имена именованных констант включают ТОЛЬКО ЗАГЛАВ-НЫЕБУКВЫ.

Имена макросов включают ТОЛЬКО ЗАГЛАВНЫЕ БУКВЫ.

Имена элементов перечислений дополняются именем самого перечисления в единственном числе: ColorRed, Color Blue.

Табл. 11-4. Пример конвенции именования для языка С

Сущность

Описание

TypeName

GlobalRoutineNameQ fJFileRoutineNameO

LocalVariable

RoutineParameter

f FileStaticVariable

G GLOBAL Glo-balVariable

Имена типов начинаются с заглавной буквы и включают буквы обоих регистров.

Имена открытых методов включают буквы обоих регистров.

Имена методов, видимых в одном модуле (файле), дополняются префиксом / .

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

Имена параметров методов форматируются так же, как имена локальных переменных.

Имена переменных, видимых в одном модуле (файле), дополняются префиксом.

Имена глобальных переменных дополняются префиксом G и обозначением модуля (файла), в котором определена переменная; обозначение модуля (файла) включает только заглавные буквы: SCREEN Dimensions.



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.0063