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

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

Если файл содержит более одного класса, четко определяйте границы каждого класса Взаимосвязанные методы должны быть сгруппированы в классы. Читатель, просматривающий код, должен иметь возможность легко определить, где какой класс. Четко выделяйте каждый класс с помощью нескольких пустых строк между концом одного и началом следующего класса. Класс - как глава в книге. В книге вы начинаете каждую главу с новой страницы и выделяете ее заголовок крупным шрифтом. Подчеркивайте начало каждого класса подобным образом. Пример разделения классов показан в листинге 31-66:

Листинг 31-66. Пример форматирования разделения между классами на С++

- Это последний метод в классе.

"-/Z Создаем строку, идентичную sourceString, за исключением пробелов, заменяемых подчеркиваниями, void EditString::ConvertBlanks( char *sourceString, char *targetString ) {

Assert( strlen( sourceString ) <= MAX STRING LENGTH ); Assert( sourceString != NULL ); Assert( targetString NULL ); int charlndex = 0; do {

if ( sourceString[ charlndex ]"""){ targetString[ charlndex ] = ;

else {

targetString[ charlndex ] - sourceString[ charlndex ];

charlndex++; } while sourceString[ charlndex ] != \0;

- Начало нового класса отмечается несколькими пустыми строками и именем этого класса.

L ----------------------------------------------------------------------

МАТЕМАТИЧЕСКИЕ ФУНКЦИИ

Этот класс содержит математические функции программы. L ----------------------------------------------------------------------

I- Это первый метод в новом классе.

Ищем арифметический максимум аргументов argi и arg2. int Math::Max( int argi, int arg2 ) { if ( argi > arg2 ) { return argi;

else {

return arg2;



Этот метод отделяется от предыдущего только пустыми строками.

- Ищем арифметический минимум аргументов argi и arg2. int Math::Min( int argi, int arg2 ) { if ( arg1 < arg2 ) { return argi;

else {

return arg2;

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

Листинг 31-67. Пример излишнего форматирования класса (С++)

к-к-к-к-к-к-к-к*********

I ******************

II МАТЕМАТИЧЕСКИЕ ФУНКЦИИ

Этот класс содержит математические функции программы. .................................,..............,.....

******************

*****************************************

у/у/**********************************************************************

Ищем арифметический максимум аргументов argi и arg2. int Math::Max( int argi, int arg2 ) {

**********************************************************************

if ( argi > arg2 ) { return argi;

else {

return arg2;

****************************************************

Ищем арифметический минимум аргументов argi и arg2. ****************************************************

int Math::Min( int argi, int arg2 ) { ****************************************************

if ( argi < arg2 ) { return argi;

else {

return arg2;



В этом примере столь многое выделено звездочками, что в результате ни на чем нельзя сделать акцент. Программа превращается в звездное небо. И хотя это больше эстетический, а не технический вопрос, но в форматировании действует принцип «чем меньше, тем лучше».

Если вам нужно разделять части программы длинными строками специальных символов, разработайте их иерархию (от самых плотных к самым прозрачным) и не рассчитывайте исключительно на звездочки. Так, звездочки можно применять для разделения классов, пунктирную линию - для методов, а пустые строки - для важных комментариев. Воздерживайтесь от размещения по соседству двух строк звездочек или пунктира (листинг 31-68):

Листинг 31-68. Пример хорошего форматирования с ограничениями (С++)

МАТЕМАТИЧЕСКИЕ ФУНКЦИИ

Этот класс содержит математические функции программы.

г- Легковесность этой строки по сравнению со строкой звездочек визуально подчеркивает тот факт, что метод подчиняется классу.

-> ----------------------------------------------------------------------

Ищем арифметический максимум аргументов argi и arg2.

----------------------------------------------------------------------

int Math::Max( int argi, int arg2 ) { if ( argi > arg2 ) { return argi;

else {

return arg2;

ii Ищем арифметический минимум аргументов argi и arg2. -----------------------------------------------------

int Math::Min( int argi, int arg2 ) { if ( argi < arg2 ) { return argi;

else {

return arg2;

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



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