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

[psycho-coder]

Ну что ж, вставлю свои пять копеек.

В C/C++/C#/php
табуляция 4 символа

В C
стиль кода
void some_func();
#define SOME_CONST <val>

В C++/C#
void someFunc();
const SOME_CONST = <val>;

В php если не ООП
function some_func();
если ООП
function someFunc();
define('SOME_CONST', '<val>');

В Delphi/Pascal табуляция 2 пробела
function SomeFunc(): Boolean;
const SOME_CONST = <val>;

C/C++/C#

void foo();
void foo()
{
    /*
      Comment block
    */

    int i = 0;
    int top = 10;

    for (; i < top; i++)
        top += i;

    if (true) 
        return false; // Comment line
}

php

function foo();
function foo()
{
    /*
      Commeny block
    */
    $top = 10;

    for ($i = 0; $i < $top; $i++)
        $top += $i;

    if (true) 
        return false; // Comment line
}

Delphi/Pascal

function Foo(): Boolean;
function Foo(): Boolean;
var
  i, top: Integer;
begin
  Result := true;
  (*
    Comment block
  *)

  {
    Or Comment block
  }

  top := 10;

  for i := 0 to top - 1 do
    top := top + i;

  if (true) 
    Result := false; // Comment line
end;

[Arigato]

psycho-coder
А почему по 2 заголовка функции?

Еще бы я в варианте Си указывал бы нижний предел цикла в заголовке цикла, а то кто его знает, где выше по коду переменная i определена, очень неудобно.

[anyx]

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

//--------- Показать текст
void __cdecl Show_TextBox(wchar_t* text, char b, int parmament){

DWORD A = ADDRESS_TextBox_Show;

 __asm { 
   push parmament
   push b
   push text
   call A
 }

};

//--------- загрузит запрошеные стимы
void LoadRequestedStreams(int a){
DWORD A = ADDRESS_loadRequestedStreams;

 __asm { 
   push a
   call A
 }

};

//--------- запросить стрим
void RequestStream(int ModelID, BYTE flag){
DWORD A = ADDRESS_RequestStream;

 __asm { 
   push flag
   push ModelID
   call A
 };

};

Господи, а зачем на асме-то???!!!

[Rififi]

VintProg

//--------------- Живой ли пед ------------------
bool Ped_IsAlive(void *Ped){

А кто такой пед - педофил что ли?
Хм.. интересно, что это за игру такую вы разрабатываете...

Пожалуйста не пугайтесь.

да уж даже теперь и не знаю...
((((((((((((Ж

[psycho-coder]

А почему по 2 заголовка функции?

Прототип и функция

Еще бы я в варианте Си указывал бы нижний предел цикла в заголовке цикла, а то кто его знает, где выше по коду переменная i определена, очень неудобно.

Это просто пример. А там кому как удобней

[vovk]

Спасибо за тему, кто бы её не начал))
Прочитал всё вдумчиво, ибо практики мало, а на собственном опыте научился только
выделять блоки отступами,
отделять методы //***,
комментировать энды блоков,
выделять локальные переменные,
давать осмысленные имена переменным (пусть даже и длинные).

Пожалуй всё..
А тут увидел ссылки на литературу по оформлению кода.

ЗЫ Очень переживал за Utkin (без сарказма)
когда возникла полемика вокруг его (на мой взгляд) хорошего утверждения о необходимости комментирования практически каждой строки кода( я думаю, что понял его правильно).
Особенно расстроило что оппонентами были MaTBeu и Пепел Феникса которых как я думаю уважает каждый форумчанин. Именно по этому , я их видение темы прочитал внимательно и постараюсь взять на вооружение.
Utkin //читал статьи, очень интересные бывают решения
Пепел Феникса // замечательные ответы хотя иногда не нравятся))
Вадим Мошев //всегда читаю, хотя не всё поддерживаю
Arigato //замечательный подход
pu4koff //всегда прислушиваюсь
Rififi //замечательно, но иногда очень эмоционально
MaTBeu // уважаю мнение
Человек_Борща //спасибо за написанное
psycho-coder //бывает очень интересно))

Извините если кого забыл))


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

[VintProg]

Rififi
это CPed - класс
сокращено Ped, а так Pedestrian, что трудно догадается? Что это пешеход.


anyx
А затем, что это вставка в игру, и вызов игровых функций.

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

что трудно догадается?

да трудно.
это пример плохих сокращений.
не одно слово подходит под сокращение.

А затем, что это вставка в игру, и вызов игровых функций.

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

Особенно расстроило что оппонентами были MaTBeu и Пепел Феникса

где?

PS: не знаю уважают меня или нет, я не парюсь по этому поводу, я просто тот кто я есть.

[crazy horse]

Многие опытные программисты форума частенько жалуются на плохую читаемость кода. Конечно же каждый программист обладает так называемым "почерком" (стилем программирования). Но, согласитесь, у некоторых очень неразборчивые "почерки". Предлагаю тем, кто жалуется, в этой теме тезисно изложить рекомендуемые правила(от себя или где - нибудь общепринятые).

Наша сказка хороша, начинай сначала.

У каждого языка, у каждых разработчиков есть конвенция оформления кода. Например as3 - http://opensource.adobe.com/wiki/dis...ng+Conventions И не надо эти сопли, споры и огород развозить по всему форуму в 50 темах. Если не устраивают международные соглашения - придумайте свои, удобнее. И не обижайтесь потом, что их никто не понимает. Отдельной ипостасией идут соглашения внутри организации, но это совсем другой случай.

[MaTBeu]

2vovk
Никто тут не сомневается в профессионализме товарища Utkin'a. В данной теме мы просто обсудили положительные и отрицательные стороны каждого из предложеных подходов к коментированию/документрованию/оформлению кода.

Если я своими высказываниями или еще чем-то кого-то обидел или оскорбил - прошу прощения. Никогда не имел на уме подобного.

2crazy horse
Дело в том, что международных конвенций придерживается только тот, кто о них знает. Но зачастую код пишут программисты, которые не знают о конвенциях и прочем. Поэтому сложно определить какой тут подход лучше.