реклама на сайте
подробности

 
 
7 страниц V   1 2 3 > »   
Reply to this topicStart new topic
> О стилистике при оформлении исходников, для начинающих и не только
rezident
сообщение Feb 11 2010, 12:06
Сообщение #1


Гуру
******

Группа: Свой
Сообщений: 10 920
Регистрация: 5-04-05
Пользователь №: 3 882



Цитата(sergey sva @ Feb 11 2010, 14:48) *
#define dataflag (1<<6)
Не в тему, но... есть устоявшееся правило: макросы принято обозначать заглавными буквами, а переменные и функции прописными или сочетанием заглавных и прописных. Так проще воспринимается текст исходника. В приложении русскоязычный перевод Application Note (AN-2000) "Стандарт кодирования на Си", от Micrium, Inc.

Поскольку невольно мое сообщения послужило началом своего рода оффтопка, то выделил подветку из http://electronix.ru/forum/index.php?showtopic=72745 в отдельную тему.

Сообщение отредактировал rezident - Feb 13 2010, 19:58
Прикрепленные файлы
Прикрепленный файл  micrium_an_2000_rus.pdf ( 166.36 килобайт ) Кол-во скачиваний: 1408
 
Go to the top of the page
 
+Quote Post
sergey sva
сообщение Feb 12 2010, 07:08
Сообщение #2


Гуру
******

Группа: Свой
Сообщений: 2 546
Регистрация: 23-05-07
Из: Самарская область Сызрань
Пользователь №: 27 923



Спасибо. прочитаю.
Go to the top of the page
 
+Quote Post
demiurg_spb
сообщение Feb 13 2010, 09:45
Сообщение #3


неотягощённый злом
******

Группа: Свой
Сообщений: 2 746
Регистрация: 31-01-08
Из: Санкт-Петербург
Пользователь №: 34 643



Цитата(sergey sva @ Feb 12 2010, 10:08) *
Спасибо. прочитаю.
Не советую ВСЁ принимать близко к сердцу.


--------------------
“Будьте внимательны к своим мыслям - они начало поступков” (Лао-Цзы)
Go to the top of the page
 
+Quote Post
sergeeff
сообщение Feb 13 2010, 11:16
Сообщение #4


Профессионал
*****

Группа: Свой
Сообщений: 1 481
Регистрация: 10-04-05
Пользователь №: 4 007



Да уж, хватает совершенно безаппеляционных и ничем не оправданных утверждений.
Go to the top of the page
 
+Quote Post
aaarrr
сообщение Feb 13 2010, 11:32
Сообщение #5


Гуру
******

Группа: Свой
Сообщений: 10 713
Регистрация: 11-12-04
Пользователь №: 1 448



Цитата(sergeeff @ Feb 13 2010, 14:16) *
Да уж, хватает совершенно безаппеляционных и ничем не оправданных утверждений.

Ну, внутрикорпоративным правилам и положено быть безапелляционными.

Но соглашусь, с моей точки зрения, приведенный документ содержит один из худших возможных вариантов "стандарта кодирования".
Go to the top of the page
 
+Quote Post
Dog Pawlowa
сообщение Feb 13 2010, 15:53
Сообщение #6


Гуру
******

Группа: Свой
Сообщений: 2 702
Регистрация: 14-07-06
Пользователь №: 18 823



Цитата(aaarrr @ Feb 13 2010, 15:32) *
приведенный документ содержит один из худших возможных вариантов "стандарта кодирования".

Лучше иметь правила, чем не иметь.
А что больше всего не нравится?


--------------------
Уходя, оставьте свет...
Go to the top of the page
 
+Quote Post
_Pasha
сообщение Feb 13 2010, 16:00
Сообщение #7


;
******

Группа: Участник
Сообщений: 5 646
Регистрация: 1-08-07
Пользователь №: 29 509



Цитата(demiurg_spb @ Feb 13 2010, 12:45) *
Не советую ВСЁ принимать близко к сердцу.


Цитата(aaarrr @ Feb 13 2010, 14:32) *
Но соглашусь, с моей точки зрения, приведенный документ содержит один из худших возможных вариантов "стандарта кодирования".


В довесок читаем MISRA rules, дуреем и радостно находим после у себя остатки извилин. biggrin.gif
Go to the top of the page
 
+Quote Post
zltigo
сообщение Feb 13 2010, 16:23
Сообщение #8


Гуру
******

Группа: Свой
Сообщений: 13 372
Регистрация: 27-11-04
Из: Riga, Latvia
Пользователь №: 1 244



Цитата(Dog Pawlowa @ Feb 13 2010, 18:53) *
Лучше иметь правила, чем не иметь.
А что больше всего не нравится?

В порядке упоминания:
- типа пишите в стиле "моя твоя понимай", дабы любой чукча мог понять? Но я не чукча sad.gif
- не используйте goto - где-то кто-то что-то слышал, что "настоящие программисты" так делать не должны.
- не используйте табуляцию - чистое ламерство sad.gif
- никогда не пишите комментарии над кодом - ну просто бред. Комментировать каждую строчку, тем более побитую в соответствии
чукотским восприятием - это глупость, комментируется именно блок операторов и в комментарии описывается что глобально делается а
не что такое 2 + 2.
- используйте #if 0 для комментирования блоков - трюкачи, блин, а нормальные редакторы и компиляторы не судьба пользовать.

Дальше по нарастающей sad.gif

Цитата(_Pasha @ Feb 13 2010, 19:00) *
В довесок...

Да, это самая известная по дебильности попытка заставить обезьяну программировать без ошибок и использовать жалкие подобия компиляторов.


--------------------
Feci, quod potui, faciant meliora potentes
Go to the top of the page
 
+Quote Post
aaarrr
сообщение Feb 13 2010, 16:30
Сообщение #9


Гуру
******

Группа: Свой
Сообщений: 10 713
Регистрация: 11-12-04
Пользователь №: 1 448



Цитата(Dog Pawlowa @ Feb 13 2010, 18:53) *
А что больше всего не нравится?

Оформление блоков типа:
Код
if (bla-bla) {
    ...
}

И пробелы вместо табуляции тоже бесят.

Далее:
- !defined(X)
- Дикая бредятина про многострочные комментарии
- Лишние пробелы везде и всюду
Go to the top of the page
 
+Quote Post
_Pasha
сообщение Feb 13 2010, 17:56
Сообщение #10


;
******

Группа: Участник
Сообщений: 5 646
Регистрация: 1-08-07
Пользователь №: 29 509



Цитата(aaarrr @ Feb 13 2010, 19:30) *
Оформление блоков типа:
Код
if (bla-bla) {
    ...
}

Кстати, поскольку устоявшиеся стили code folding в соответствующих редакторах (codeblocks например) показывают свернутые блоки в виде
Код
{
------------------------------

считаю полезным помещать комментарии к блоку сразу за скобкой.
И еще никогда не понимал смысла вот такого форматирования (это Astyle):
Код
struct
{
  unsigned field1
  :1;
}

Нафига такая фигня фигачецца?
Go to the top of the page
 
+Quote Post
Dog Pawlowa
сообщение Feb 13 2010, 18:39
Сообщение #11


Гуру
******

Группа: Свой
Сообщений: 2 702
Регистрация: 14-07-06
Пользователь №: 18 823



А я терзаниях по поводу табуляции.
После ассемблера и Паскаля использование табуляции считал обязательным.
В ИАРе четыре года назад сделал табуляцию два пробела - на ноутбуке приходилось работать, иначе ничего не видно.
Но теперь приходится иногда глянуть текст чем-нибудь по f3/f4, получается ерунда.
То ли переходить на пробелы, то ли на tab= 4 (что пишут), теперь с шириной экрана 17' уже некритично.


--------------------
Уходя, оставьте свет...
Go to the top of the page
 
+Quote Post
aaarrr
сообщение Feb 13 2010, 18:53
Сообщение #12


Гуру
******

Группа: Свой
Сообщений: 10 713
Регистрация: 11-12-04
Пользователь №: 1 448



ИМХО, tab 4 - самый правильный способ.
Go to the top of the page
 
+Quote Post
zltigo
сообщение Feb 13 2010, 19:43
Сообщение #13


Гуру
******

Группа: Свой
Сообщений: 13 372
Регистрация: 27-11-04
Из: Riga, Latvia
Пользователь №: 1 244



Цитата(aaarrr @ Feb 13 2010, 21:53) *
ИМХО, tab 4 - самый правильный способ.

Для 'C' - 4. Для ASM - 8


Цитата(Dog Pawlowa @ Feb 13 2010, 21:39) *
В ИАРе четыре года назад сделал табуляцию два пробела - на ноутбуке приходилось работать, иначе ничего не видно.

Ничего не понял. Начинал работать на каком-нибудь 14" CRT и никаких проблем от 4 не имел.


--------------------
Feci, quod potui, faciant meliora potentes
Go to the top of the page
 
+Quote Post
rezident
сообщение Feb 13 2010, 19:44
Сообщение #14


Гуру
******

Группа: Свой
Сообщений: 10 920
Регистрация: 5-04-05
Пользователь №: 3 882



Цитата(aaarrr @ Feb 13 2010, 23:53) *
ИМХО, tab 4 - самый правильный способ.

Именно по этой причине некоторые программисты (считающие TAB "самым правильным способом") так привязаны к конкретным (самым правильным) редакторам biggrin.gif Правда потом их цитаты исходников на форуме приходится править (чтобы многочисленными TABами страницу в браузере не распирало), но ведь это работа модератора, а не барина пользователя, не так ли?
Go to the top of the page
 
+Quote Post
aaarrr
сообщение Feb 13 2010, 19:58
Сообщение #15


Гуру
******

Группа: Свой
Сообщений: 10 713
Регистрация: 11-12-04
Пользователь №: 1 448



Цитата(rezident @ Feb 13 2010, 22:44) *
Именно по этой причине некоторые программисты (считающие TAB "самым правильным способом") так привязаны к конкретным (самым правильным) редакторам biggrin.gif

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

Цитата(rezident @ Feb 13 2010, 22:44) *
Правда потом их цитаты исходников на форуме приходится править (чтобы многочисленными TABами страницу в браузере не распирало), но ведь это работа модератора, а не барина пользователя, не так ли?

Мне почему-то казалось, что код обычно пишется не для выкладывания на форум.
Go to the top of the page
 
+Quote Post

7 страниц V   1 2 3 > » 
Reply to this topicStart new topic
1 чел. читают эту тему (гостей: 1, скрытых пользователей: 0)
Пользователей: 0

 


RSS Текстовая версия Сейчас: 20th July 2025 - 23:47
Рейтинг@Mail.ru


Страница сгенерированна за 0.01475 секунд с 7
ELECTRONIX ©2004-2016