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

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

рядок соответствует последовательности выполняемых в методе операций: ввод данных, их изменение и возврат результата. Вот примеры списков параметров, написанные на языке Ada:

Примеры размещения параметров в порядке «входные значения -изменяемые значения - выходные значения» (Ada)

procedure InvertMatrix(

~ В языке Ada ключевые слова in и out поясняют суть входных и выходных параметров.

-> originalMatrix: in Matrix; resultMatrix: out Matrix

procedure ChangeSentenceCase( desiredCase: in StringCase; sentence: in out Sentence

procedure PrintPageNumber( pageNumber: in Integer; status: out StatusType

Такая конвенция упорядочения параметров противоречит конвенции библиотек С, предполагающей указание изменяемого параметра в первую очередь. Конвенция «входные значения - изменяемые значения - выходные значения» кажется мне более разумной, но, даже если вы будете согласованно упорядочивать параметры любым иначе, вы окажете услугу программистам, которым придется читать ваш код.

Подумайте о создании собственных ключевых слов in и out В отличие от Ada другие языки не поддерживают ключевые слова in и out. Однако даже в этом случае вы скорее всего сможете создать их с помощью препроцессора:

Пример определения собственных ключевых слов In и Out (С++)

#define IN

#define OUT

void InvertMatrix(

IN Matrix originalMatrix,

OUT Matrix *resultMatrix

void ChangeSentenceCase( IN StringCase desiredCase, IN OUT Sentence *sentenceToEdit



void PrintPageNumber( IN int pageNumber, OUT StatusType &status

В данном примере ключевые слова-макросы IN и OUT используются для документирования. Чтобы значение параметра можно было изменить в вызванном методе, параметр все же нужно передавать по указателю или по ссылке.

Прежде чем принять этот подход, обдумайте два его важных недостатка. Собственные ключевые слова IN и OUT окажутся незнакомыми большинству программистов, которые будут читать ваш код. Расширяя язык таким образом, делайте это согласованно, лучше всего в масштабе всего проекта. Второй недостаток в том, что компилятор не будет проверять соответствие параметров ключевым словам IN и OUT, из-за чего вы сможете отметить параметр как IN и все же изменить его внутри метода. Так вы только введете программиста, читающего ваш код, в заблуждение. Обычно для определения исключительно входных параметров лучше применять ключевое слово const языка С++.

Если несколько методов используют похожие параметры, передавайте их в согласованном порядке Порядок параметров может как облегчить, так и затруднить их запоминание. Например, в С прототипы методов fprintfO и printfQ различаются только тем, что fprintfO принимает файл в качестве дополнительного первого аргумента. Похожее отношение наблюдается и между методами fputsQ и putsQ, но в fputsQ файл передается последним. Это досадное различие только затрудняет запоминание параметров названных методов.

С другой стороны, методы stmcpyQ и memcpyQ в том же С принимают аргументы в одинаковом порядке: строка-приемник, строка-источник и максимальное число копируемых байт. Такое сходство помогает запомнить параметры обоих методов.

Используйте все параметры Если вы передаете параметр в метод, используйте его, в противном случае удалите параметр из интерфейса метода. Наличие неиспользуемых параметров соответствует более высокому уровню ошибок. Исследования показали, что ошибки отсутствовали в 4б% методов, не включавших неиспользуемых переменных, и только в 17-29% методов, содержавших более одной неиспользуемой переменной (Card, Church, and Agresti, 1986).

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

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



Не используйте параметры метода в качестве рабочих переменных Использовать передаваемые в метод параметры как рабочие переменные опасно. Создайте для этой цели локальные переменные. Так, в следующем фрагменте Java-кода переменная inputVal некорректно служит для хранения промежуточных результатов вычислений:

Пример некорректного использования входного параметра (Java)

int Sample( int inputVal ) {

inputVal = inputVal * CurrentMultiplier( inputVal ); inputVal = inputVal + CurrentAclcler( inputVal );

p Переменная inputVal уже не содержит входного значения.

-> return inputVal; }

В этом фрагменте переменная inputVal вводит в заблуждение, потому что при завершении метода она больше не содержит входного значения; она содержит результат вычисления, частично основанного на входном значении, и поэтому ее имя неудачно. Если позднее вам придется задействовать первоначальное входное значение в другом месте метода, вы, вероятно, задействуйте переменную inputVal, предполагая, что она содержит первоначальное значение, но это предположение будет ошибочным.

Можно ли решить эту проблему путем переименования inputVal? Наверное, нет. Переменной можно было бы присвоить имя вроде workingVal, но такое решение было бы неполным, так как это имя не говорит о том, что первоначальное значение переменной передается в метод извне. Вы могли бы присвоить ей нелепое имя input-ValTbatBecomesWorkingVal (входное значение, которое становится рабочим значением) или сдаться и просто назвать ее х или val, но все эти подходы неудачны.

Лучше избегать настоящих и будущих проблем, используя рабочие переменные явно, например:

Пример корректного использования входного параметра (Java)

int Sample( int inputVal ) { int workingVal = inputVal;

workingVal = workingVal * CurrentMultiplier( workingVal ); workingVal = workingVal + CurrentAclcler( workingVal );

Если первоначальное значение inputVal понадобится здесь или где-то еще, оно все еще доступно.

return workingVal;



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