Рекомендуемые правила оформления кода

[Пепел Феникса]

Вы не поняли сути - описывается не i++. Описывается алгоритм.

зачем куча комментариев когда можно написать код так что он будет вполне понятен?
а в документации уже описывается сам алгоритм.

вообще код это реализация алгоритма.

[MaTBeu]

Сообщение от Utkin

Вы не поняли сути - описывается не i++. Описывается алгоритм.

Я бы был более осторожен в оценках и навешиваемых ярлыках.

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

Если нужно описать алгоритм, то проще написать к нему документацию (она для этого и создана).

Извините, если я вас неправильно понял.

[Utkin]

Ну если Вы такие все такие правильные , объясните чем занимается фрагмент данной функции на Дельфи:

      result:=False;
      buf:=Stroka;      
      Flag[1]:=CheckNumberStroka(Nabor[Index].Slovo[1]);
      Flag[2]:=CheckNumberStroka(Nabor[Index].Slovo[2]);
      Flag[3]:=CheckNumberStroka(Nabor[Index].Slovo[3]);
      Flag[4]:=CheckNumberStroka(Nabor[Index].Slovo[4]);
      Flag[5]:=CheckNumberStroka(Nabor[Index].Slovo[5]);
      Flag[6]:=CheckNumberStroka(Nabor[Index].Slovo[6]);
      Flag[7]:=CheckNumberStroka(Nabor[Index].Slovo[7]);
      Flag[8]:=CheckNumberStroka(Nabor[Index].Slovo[8]);
      Dlina:=GetIndex(buf, ' ');
      For i:=1 to 8 do
      begin
          If Nabor[Index].Slovo[i]='' then
          begin
              Dlina:=i-1;
              Break;
          end;
      end;
    If Dlina>8 then Dlina:=8;
    if Flag[Dlina]=true then Dec(Dlina);
    if Dlina<1 then Exit;
    for i:=1 to Dlina do
    begin
          k:=i+1;
          if (flag[i]=false) or (flag[k]=false) then
          begin
            If flag[i]=true then
            begin
                if i<8 then
                begin
                    x:=buf;
                    buf:=GetEnd(buf, Nabor[Index].Slovo[k]);
                    uk:=StrToInt(Nabor[Index].Slovo[i]);
                    if (uk<0) or (Uk>8) then Exit;
                    Constr.Param[Uk]:=Copy(x, 1, Length(x)-Length(buf));
                end;
            end
            Else
            begin
                if buf='' then Exit;
                z:=AnsiUpperCase(GetItemMas(buf, ' ', 1));
                if Nabor[Index].Slovo[i]<>'' then
                begin
                    If CheckInSet(AnsiUpperCase(Nabor[Index].Slovo[i]), z)=False then
                    begin
                        Constr.Param[1]:='';
                        Constr.Param[2]:='';
                        Constr.Param[3]:='';
                        Constr.Param[4]:='';
                        Constr.Param[5]:='';
                        Constr.Param[6]:='';
                        Constr.Param[7]:='';
                        Constr.Param[8]:='';
                        Exit;
                    end;
                end;
                buf:=DelItemMas(buf, ' ', 1);
            end;
          end;
    end;

Это начало функции. Я думаю для данного фрагмента комментарии для Вас будут абсолютно излишними.

[still_alive]

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

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

PS раньше юзал doxygen, но в последний год он мне разонравился как-то...

PPS есть довольно неплохой google c++ style guide, а еще qt coding style

Это начало функции. Я думаю для данного фрагмента комментарии для Вас будут абсолютно излишними.

Абсолютно излишними. Достаточно взглянуть на ЭТО один раз и попросить переписать с нуля.

[Utkin]

still_alive, я могу назвать Вас верхом неадекватности. Ибо вопрос стоял не о качестве кода. Что за еврейские подходы к решению задачи? Вы же прошли гигабайты кода и должны знать что подобного хлама всегда больше чем действительно хорошего. Кстати, он работает. Мне ли Вас учить - тут не то что рефакторинга - банальная автозамена в 5 минут улучшит ситуацию. Вопрос в другом как бы.

[Пепел Феникса]

1)совмещение английского и транслита это ужас.
2)разбор синтаксических конструкций, макс размер конструкции 8.

Абсолютно излишними. Достаточно взглянуть на ЭТО один раз и попросить переписать с нуля.

.
отчасти согласен.

кстати, еще одна вещь, верная что для Делфи, что для С++.
лучше писать обращение к самому себе через this/Self.

[still_alive]

still_alive, я могу назвать Вас верхом неадекватности. Ибо вопрос стоял не о качестве кода. Что за еврейские подходы к решению задачи?

Ну-ну. Вы б еще код в одну строчку привели и спросили - а чо это там делается? В нормальном проекте такого кода просто нет, а другие мне нафиг не сдались. А вам?

[Utkin]

Я собственно такого ответа и ожидал . Нет ни одного четкого ответа по вопросу. Ближе всех был Пепел Феникса (но я для него и закидывал удочку). Зато сколько умных слов . Право я повторюсь - не спешите с выводами.

1)совмещение английского и транслита это ужас.

Я уже ответил, но еще раз второй аргумент - вопрос состоял в другом.

2)разбор синтаксических конструкций, макс размер конструкции 8.

Близко, но не правда. Я вижу Ваши методы на практике не работают.

В нормальном проекте такого кода просто нет, а другие мне нафиг не сдались. А вам?

А меня никто не спрашивает. Мне дают и говорят чтобы вчера было сделано. Данный код мой (я еще только учился), но он показателен.

[Пепел Феникса]

Уткин, а разве код идеален?

[Utkin]

Уткин, разве я не прав про кусок кода?

Нет. Это очень близко, но не совсем то. Скажем так, если бы код содержал ошибку, Вы бы ее не нашли.
Допустим имеется строка x=x+1 и х = х+1
Какая строка будет распознана, а какая нет? Уточню данная функция возвращает Boolean. Какой будет результат функции для первого, и какой для второго вариантов?

Уткин, а разве код идеален?

В чем же его изъяны ? Я не тролль отвечу заранее -
а) Это намек на пьяный код. Если бы Вы читали комментарии, то поняли бы и его.
б) На придирки по транслитерации и им подобные я уже писал в посте # 35. Зачем его переписывать с нуля? Это очередной Ваш минус. Нормальный человек попытается понять алгоритм - если он верен нужно провести рефакторинг.