|
Библиотеки для STM32 |
|
|
|
 |
Ответов
|
Mar 29 2017, 04:54
|

Профессионал
    
Группа: Свой
Сообщений: 1 261
Регистрация: 14-05-09
Из: Челябинск
Пользователь №: 49 045

|
есть такое...... хороший код в коментариях не нуждается. у Genadi Zawidowski скорее не комментарии, а референс мануал на его API. У Velund пустые, не нужные комментарии.... типа таких Код int a = 10; //создал переменную а, задал ей значение 10 Цитата(Baser @ Mar 28 2017, 15:14)  2. Как выше в примере - число реальное, а единицы измерений неизвестно какие (мкс, мс, сек ??) А через год нужно подкрутить код - и ищи концы по проекту. А так - комментарий присутствует  Для этого не нужны комментарии, нужны правильные имена. Код t2 = _SET_TIMEOUT_MS(100); GSMPower(0); - такой вызов без комментариев не очевиден GSMPower(OFF), GsmModemPowerOff() или GsmModemOff() не нуждается в комментариях. ps чужой код всегда плох. у каждого свой стиль, и только он true. Все остальное говнокод неправильное
|
|
|
|
|
Mar 29 2017, 08:26
|
Гуру
     
Группа: Свой
Сообщений: 5 228
Регистрация: 3-07-08
Из: Омск
Пользователь №: 38 713

|
Цитата(juvf @ Mar 29 2017, 06:54)  У Velund пустые, не нужные комментарии.... типа таких Код int a = 10; //создал переменную а, задал ей значение 10 Согласен. Такие комментарии делают обратное - только ухудшают читаемость исходника, загромождая его. Цитата(Alechek @ Mar 29 2017, 08:29)  Порой не хочется читать код, а просто прочитать по-русски, что же тут хотели сделать. Бывает так, что комментарий верный, а вот в коде ошибка закралась.... А бывает и наоборот. Очень часто бывает (много раз сталкивался на практике), когда код написали вместе с комментами, а потом начали отлаживать-отлаживать-отлаживать. В результате код сильно изменился (до совершенно другого), а комменты каждый раз при отладке конечно лень менять. В результате получаем комменты не соответствующие коду, и наоборот - только вводящие в заблуждение. Поэтому я, например, при первоначальном написании, комменты почти не пишу. А пишу их только когда исходник более-менее устаканится и заработает как надо.
|
|
|
|
|
Mar 29 2017, 16:47
|

Профессионал
    
Группа: Свой
Сообщений: 1 215
Регистрация: 22-02-05
Пользователь №: 2 831

|
Цитата(jcxz @ Mar 29 2017, 11:26)  Поэтому я, например, при первоначальном написании, комменты почти не пишу. А пишу их только когда исходник более-менее устаканится и заработает как надо. В свое время, чтобы не метаться между разными способами оформления кода, мне помогла соответствующая литература. Например, много лет назад, пригодилась эта: "Веревка достаточной длины, чтобы выстрелить себе в ногу", ее легко найти в гугле. Правда, помню, что с многими моментами я там был не очень согласен. Это мягко говоря ))) Но потом попалась в руки эта книжка: Мартин - "Чистый код". К тому моменту она была мне очень кстати - вычитал ее запоем всю до дыр  Кто уже плотно сидит на "плюсах" и тем более уже созрел строить полноценный объектный код, используя всю мощь "плюсов", вторую книжка будет очень полезна, по крайней мере мне она очень пригодилась. Благодаря этой книжке мне удалось составить собственную "конвенцию именования", очень лаконичную и простую, но при этом предельно однозначную, что значительно улучшило читаемость кода:
ps, Картинка не ради разведения очередного холивара, а, просто - вдруг кому-то пригодится ))
--------------------
Кругозор некоторых людей - круг с нулевым радиусом. Они называют его "точкой зрения".
|
|
|
|
|
Mar 30 2017, 10:34
|

Профессионал
    
Группа: Свой
Сообщений: 1 215
Регистрация: 22-02-05
Пользователь №: 2 831

|
Цитата(juvf @ Mar 30 2017, 12:39)  а мне помогла небольшая шпаргалка Прям с языка сняли!!!  Правда с некоторыми пунктами я не очень согласен, в частности с теми, которые имеют приписку "Это правило пришло из математики...". Предпочитаю математику (да и не только математику, но и другие дисциплины) с ее короткими и малоинформативными именами и именами в коде не смешивать, не путать "мух с колетами"  Скажем "скорость" называть не 'v', а как положено - velocity, т. е. в данных случаях сокращения, пришедшие из фундаментальных вековых дисциплин, могут сильно усложнить чтение кода. Дело в том, что в те далекие времена английский не был, можно сказать, "всемирным" языком, и потому чаще всего использовались лишь сокращения от латинских названий терминов, К тому же практически все писалось от руки. Но те времена уже давно прошли, поэтому я лично не вижу никакого смысла цепляться за них в коде. Например, вместо "i" использую переменную, носящую конкретный смысл для кода, где она используется: index, iterarator, value ..., составные: itemIndex, objectIterator и и т.п. Но в примитивных случаях (скажем, цикл из одной строки), "классическое i" вполне сгодится, иначе увеличивается сложность чтения кода. Для отладки полноценные имена (в том числи и счетчики циклов, итераторы и т. п.) тоже очень полезны - в окне watch переменные несут явный и однозначный смысл. Разумеется, при условии, что переменные и объекты названы правильно  Вообще, мне кажется, что самое сложный, но и самый полезный навык в программировании - умение правильно подбирать "сущностям" и "действиям" однозначные и лаконичные имена ....
--------------------
Кругозор некоторых людей - круг с нулевым радиусом. Они называют его "точкой зрения".
|
|
|
|
Сообщений в этой теме
juvf Библиотеки для STM32 Mar 3 2017, 02:54 arhiv6 SPL тут лежит. Но STM вместо SPL теперь HAL продви... Mar 3 2017, 03:26 juvf Цитата(arhiv6 @ Mar 3 2017, 08:26) SPL ту... Mar 3 2017, 06:22  MoskWin32 Цитата(juvf @ Mar 3 2017, 09:22) А для st... Mar 3 2017, 06:47  arhiv6 Цитата(juvf @ Mar 3 2017, 13:22) Спасибо.... Mar 3 2017, 06:54  jcxz Цитата(juvf @ Mar 3 2017, 08:22) можно и ... Mar 3 2017, 14:31   juvf Цитата(jcxz @ Mar 3 2017, 19:31) Самостоя... Mar 3 2017, 18:43  Utyff Цитата(juvf @ Mar 3 2017, 09:22) можно и ... Mar 3 2017, 15:21   scifi Цитата(Utyff @ Mar 3 2017, 18:21) Снипеты... Mar 3 2017, 15:26    dxp QUOTE (scifi @ Mar 3 2017, 22:26) Интерес... Mar 4 2017, 04:59     Эдди Цитата(dxp @ Mar 4 2017, 07:59) Или вот.
... Mar 4 2017, 09:07 Эдди Нет их. Пользуйтесь сниппетами. Я сам отказался уж... Mar 3 2017, 05:38 demiurg_spb Цитата(Эдди @ Mar 3 2017, 08:38) Я сам от... Mar 3 2017, 13:38  Эдди Цитата(demiurg_spb @ Mar 3 2017, 16:38) Ч... Mar 3 2017, 15:27   scifi Цитата(Эдди @ Mar 3 2017, 18:27) Когда по... Mar 3 2017, 15:31 PheeL Кстати, просветите насчёт сниппетов, пожалуйста. Н... Mar 3 2017, 13:51 Эдди Ну, я раньше на это не обратил внимания.
Иначе, ес... Mar 3 2017, 16:53 Genadi Zawidowski Цитатастрашен стартап? Вот, к примеру, мой
стек за... Mar 3 2017, 19:22 scifi Цитата(Genadi Zawidowski @ Mar 3 2017, 22... Mar 3 2017, 21:21 Genadi Zawidowski "огласите весь список, ппожалуйста!... Mar 3 2017, 23:16 jcxz Цитата(Genadi Zawidowski @ Mar 4 2017, 01... Mar 4 2017, 11:43  zltigo Цитата(jcxz @ Mar 4 2017, 13:43) А что в ... Mar 4 2017, 14:27   pitt Цитата(zltigo @ Mar 4 2017, 09:27) Неправ... Mar 4 2017, 15:08    SSerge Цитата(pitt @ Mar 4 2017, 22:08) Agreed 1... Mar 4 2017, 15:42 Шаманъ Что-то я не понял про привязку. У меня таблица век... Mar 5 2017, 07:04 jcxz Цитата(Шаманъ @ Mar 5 2017, 09:04) Что-то... Mar 5 2017, 20:34  Шаманъ Цитата(jcxz @ Mar 5 2017, 23:34) Скорее т... Mar 7 2017, 04:08   jcxz Цитата(Шаманъ @ Mar 7 2017, 06:08) Ну зач... Mar 7 2017, 09:57    Шаманъ Цитата(jcxz @ Mar 7 2017, 12:57) И какой ... Mar 7 2017, 15:52 Genadi Zawidowski А есть люди, кто этот массив частично описывают в ... Mar 5 2017, 10:12 yanvasiij Для этого же проца не нашел в свое время SPL. Приш... Mar 10 2017, 17:46 Эдди Цитата(yanvasiij @ Mar 10 2017, 20:46) не... Mar 11 2017, 05:01 yanvasiij Это избитая холиварная тема, спорить на которую мо... Mar 11 2017, 06:52 juvf Цитата(yanvasiij @ Mar 11 2017, 11:52) См... Mar 11 2017, 07:29 Эдди Когда я заводил 1-wire через таймер с ПДП, был пер... Mar 11 2017, 13:10 Baser Цитата(Эдди @ Mar 11 2017, 15:10) ... Пок... Mar 11 2017, 21:49  jcxz Цитата(Baser @ Mar 11 2017, 23:49) Тем бо... Mar 12 2017, 07:44  Alechek Цитата(Baser @ Mar 12 2017, 02:49) Но иде... Mar 12 2017, 16:54 Эдди Вот если бы STMщики вместо идиотизма с SPL/калокуб... Mar 12 2017, 13:39 jcxz Цитата(Эдди @ Mar 12 2017, 15:39) Непонят... Mar 12 2017, 14:10 juvf наброс говна на вентилятор продолжаем разговор....... Mar 13 2017, 05:51 Alechek Цитата(juvf @ Mar 13 2017, 10:51) LL - эт... Mar 13 2017, 09:39  jcxz Цитата(Alechek @ Mar 13 2017, 11:39) У ме... Mar 13 2017, 10:41   Velund QUOTE (jcxz @ Mar 13 2017, 13:41) Во-во -... Mar 14 2017, 11:04 Эдди Для set/clear/toggle функции не нужны, делается эт... Mar 13 2017, 08:43 Genadi Zawidowski Оооо! Я тоже на таком же велосипеде езжу!
... Mar 14 2017, 16:32 Эдди На русском комментарии делать некультурно, между п... Mar 14 2017, 17:48 ViKo Цитата(Эдди @ Mar 14 2017, 20:48) На русс... Mar 14 2017, 17:59 Эдди По крайней мере, он хотя бы поймет, о чем речь... Mar 14 2017, 20:42 Genadi Zawidowski Между прочим, на pudn кто-то залил архив моего про... Mar 14 2017, 22:28 Velund QUOTE (Genadi Zawidowski @ Mar 15 2017, 01... Mar 26 2017, 23:43 ViKo Поделитесь примером с комментариями на английском,... Mar 27 2017, 04:11 Velund QUOTE (ViKo @ Mar 27 2017, 07:11) Поделит... Mar 28 2017, 00:43 Эдди Что-то у вас излишне комментариев. Например, зачем... Mar 28 2017, 05:00 Шаманъ Цитата(Эдди @ Mar 28 2017, 08:00) Что-то ... Mar 28 2017, 07:05  Alechek Цитата(Шаманъ @ Mar 28 2017, 12:05) Комме... Mar 29 2017, 06:29 jcxz Цитата(Эдди @ Mar 28 2017, 07:00) Что-то ... Mar 28 2017, 07:22 Baser Цитата(Эдди @ Mar 28 2017, 08:00) Наприме... Mar 28 2017, 10:14  Obam Цитата(Baser @ Mar 28 2017, 14:14) 2. Как... Mar 28 2017, 11:19 Obam "…зачем комментировать очевидное — паузы?…... Mar 28 2017, 07:44 Сергей Борщ QUOTE (Obam @ Mar 28 2017, 09:44) А для ч... Mar 28 2017, 08:07 Эдди Цитата(Obam @ Mar 28 2017, 10:44) А для ч... Mar 28 2017, 10:05 Эдди Ну, я стараюсь только неочевидные вещи комментиров... Mar 28 2017, 11:05    Aaron Цитата(juvf @ Mar 30 2017, 12:39) а мне п... Apr 3 2017, 08:55     Forger Цитата(Aaron @ Apr 3 2017, 11:55) Как раз... Apr 3 2017, 09:06   Alechek Цитата(Forger @ Mar 29 2017, 21:47) Благо... Apr 1 2017, 06:37    Forger Цитата(Alechek @ Apr 1 2017, 09:37) Если ... Apr 1 2017, 09:25  zltigo Цитата(jcxz @ Mar 29 2017, 11:26) Очень ч... Apr 1 2017, 16:24 ViKo Моё.
CODE
/*!*********************************... Mar 29 2017, 07:29 Obam "Я, бывает, вначале комментариями пишу, что д... Mar 29 2017, 07:36 Kabdim +1 за гугльстайл. Самый вменяемый стайлгайд на дан... Apr 3 2017, 09:41 juvf Цитата(Kabdim @ Apr 3 2017, 14:41) +1 за ... Apr 3 2017, 10:34  Forger Цитата(juvf @ Apr 3 2017, 13:34) quitonla... Apr 3 2017, 12:37  Kabdim Цитата(juvf @ Apr 3 2017, 13:34) tablenam... Apr 3 2017, 12:58   Forger Цитата(Kabdim @ Apr 3 2017, 15:58) Как по... Apr 3 2017, 13:44   juvf Цитата(Kabdim @ Apr 3 2017, 17:58) А по п... Apr 4 2017, 05:31    Kabdim Цитата(Forger @ Apr 3 2017, 19:04) Но это... Apr 4 2017, 07:22     juvf Цитата(Kabdim @ Apr 4 2017, 12:22) Тут то... Apr 4 2017, 08:25 Aaron К чему холивар, Kabdim? Главное не инструмент (кои... Apr 3 2017, 13:51 Kabdim Извиняюсь, если мои посты вызвали ощущение холивар... Apr 3 2017, 15:39 Forger Цитата(Kabdim @ Apr 3 2017, 18:39) И при ... Apr 3 2017, 15:44  Kabdim Цитата(Forger @ Apr 3 2017, 18:44) Затрат... Apr 3 2017, 15:51   Forger Цитата(Kabdim @ Apr 3 2017, 18:51) Выходи... Apr 3 2017, 15:58    Kabdim Цитата(Forger @ Apr 3 2017, 18:58) Нужен,... Apr 3 2017, 16:00     Forger Цитата(Kabdim @ Apr 3 2017, 19:00) Чем пу... Apr 3 2017, 16:04      zltigo Цитата(Forger @ Apr 3 2017, 19:04) Но это... Apr 4 2017, 08:54       Forger Цитата(zltigo @ Apr 4 2017, 11:54) При эт... Apr 4 2017, 09:20        jcxz Цитата(Forger @ Apr 4 2017, 11:20) скажем... Apr 4 2017, 09:23        juvf Цитата(Forger @ Apr 4 2017, 14:20) приход... Apr 4 2017, 12:33         scifi Цитата(juvf @ Apr 4 2017, 15:33) я тоже н... Apr 4 2017, 12:40 Kabdim Цитата(juvf @ Apr 4 2017, 11:25) я говорю... Apr 4 2017, 08:56 Forger Цитата(Kabdim @ Apr 4 2017, 11:56) Кмк эт... Apr 4 2017, 10:28  Kabdim Цитата(Forger @ Apr 4 2017, 13:28) В С++ ... Apr 4 2017, 11:25 Aaron очевидно же - у класса есть конструкторы/деструкто... Apr 4 2017, 09:30 jcxz Цитата(Aaron @ Apr 4 2017, 11:30) очевидн... Apr 4 2017, 10:51
1 чел. читают эту тему (гостей: 1, скрытых пользователей: 0)
Пользователей: 0
|
|
|