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

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

unvw.constnix.com. Этот Web-сайт (Web-сайт моей компании) mtp: cc2exom/3229 содержит многочисленные шаблоны документов, описания

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

Post, Ed. «Real Programmers Dont Use Pascal», Datamation, July http: cc2e.cofn/3236 1933 pp 263-265. В этой ироничной статье автор тоскует

по «старым добрым временам» программирования на Фортране, когда программисты могли не волноваться о таких неприятных вопросах, как читабельность кода.

Контрольный список: хорошие методики

Шр: ос2б.соп1/3243 коммвнтирования

Общие аспекты

□ Может ли программист, взглянувший на код, сразу понять его?

□ Объясняют ли комментарии цель кода или резюмируют ли они выполняемые в коде действия вместо того, чтобы просто повторять код?

□ Используете ли вы процесс программирования с псевдокодом для сокращения времени комментирования?

□ Переписали ли вы хитрый код вместо того, чтобы комментировать его?

□ Актуальны ли комментарии?

□ Ясны ли комментарии? Корректны ли они?

□ Позволяет ли стиль комментирования с легкостью изменять комментарии? Операторы и абзацы

□ Избегаете ли вы комментариев в концах строк?

□ Стремитесь ли вы отвечать в комментариях на вопрос «почему», а не «как»?

□ Готовят ли комментарии читателя к последующему коду?

□ Каждый ли комментарий важен? Были ли удалены или улучшены избыточные, посторонние и неуместные комментарии?

□ Документируете ли вы сюрпризы?

□ Избегаете ли вы сокращений?

□ Ясно ли различие между общими и детальными комментариями?

□ Комментируете ли вы недокументированные возможности или код, предотвращающий ошибки языка или среды?

Объявления данных

□ Указываете ли вы единицы измерения данных в местах объявления данных?

□ Указываете ли вы диапазоны допустимых значений численных величин?

□ Комментируете ли вы смысл закодированных значений?

□ Комментируете ли вы ограничения входных данных?

□ Документируете ли вы флаги до уровня отдельных битов?

□ Комментируете ли вы каждую глобальную переменную в месте ее объявления?

□ Поясняете ли вы при каждом использовании глобальной переменной ее глобальный характер при помощи конвенции именования, комментария или обоих способов?

□ Заменили ли вы магические числа на именованные константы или переменные, вместо того чтобы ограничиться простым документированием?



Управляющие структуры

□ Комментируете ли вы каждый управляющий оператор?

□ Комментируете ли вы концы длинных или сложных управляющих структур или упрощаете ли вы эти структуры по мере возможности, чтобы они не требовали комментариев?

Методы

□ Комментируете ли вы назначение каждого метода?

□ Указываете ли вы в комментариях к методам в случае надобности другую информацию, такую как входные и выходные данные, предположения об интерфейсе, ограничения, исправленные ошибки, глобальные эффекты и источники алгоритмов?

Файлы, классы и программы

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

□ Описали ли вы назначение каждого файла?

□ Указали ли вы в листинге фамилию и имя автора, адрес электронной почты и номер телефона?

Ключевые моменты

Вопрос о том, стоит ли комментировать код, вполне обоснован. При плохом выполнении комментирование является пустой тратой времени и иногда причиняет вред. При грамотном применении комментирование полезно.

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

Хороший код сам является самой лучшей документацией. Если код настолько плох, что требует объемных комментариев, попытайтесь сначала улучшить его.

Комментарии должны сообщать о коде что-то такое, что он не может сообщить сам - на уровне резюме или уровне цели.

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



ГЛАВА 33

Личность

Содержание

mip: cc2e.corn/3313

33.1. Причем тут личность?

33.2. Интеллект и скромность

33.3. Любопытство

33-4. Профессиональная честность

33.5. Общение и сотрудничество

33.6. Творчество и дисциплина

33.7. Лень

33.8. Свойства, которые менее важны, чем кажется

33-9. Привычки

Связаные темы

Мастерство разработки ПО: глава 34

Сложность: разделы 5.2 и 19.6

С момента публикации в 1965 году знаменитой статьи Эдсгера Дейкстры «Prog-ramming Considered as a Human Activity» («Программирование как человеческая деятельность») личности программистов привлекают самое пристальное внимание ученых. Названия книг «Психология конструирования мостов» и «Экспериментальные исследования поведения юристов» могли бы показаться абсурдными, однако работы «Психология программирования» («The Psychology of Computer Program-ming»), «Экспериментальные исследования поведения программистов» («Exploratory Experiments in Programmer Behavior») и т. п. уже стали классическими.

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



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