В чем проектировать класс?

[Utkin]

Уже советовали, генерилка uml по коду.

Ну вот сижу выбираю под себя всяческие инструменты .

Лучшая документация это код.

Тоже не согласен. Кода там много - начинаешь разбираться - за деталями реализации теряются основы.

[the_deer_one]

crazy horse

То-то мы, дураки, возимся с вики, трекерами и репами. Оказывается, достаточно комментов.

И что у вас в вики? Умл диаграммы? Зачем рассматривать класс в виде умл схемы, если можно залезть в проект. А обновлять всё это вики счастье по каждому чиху?

[crazy horse]

Те, кому надо, вопросами "зачем" давно уже не задаются. Проектная документация, это целая идеология и в трех словах о ней не расскажешь. В вики вся документация по проекту. В трекере роадмэп и задачи текстом, с прикрученными линками на бренчи с кодом и линками на статьи в вики, если задача не из разряда "переместить вот ту хрень на два пикселя вправо". Идут к этому долго и мучительно, но обратно редко возвращаются.
Зы. Серверные апи и интерфейсы тоже смотреть лезть в код за каждым чихом? На самом деле, спецов, которые в состоянии все это поднять и аргументировать можно пересчитать по пальцам. А кодеров "в клавиатуру" - вагон, простите. Хороших, плохих, - любых полно. И вообще, дайте линк на репу с вашим кодом

Зачем рассматривать класс в виде умл схемы

Затем, чтобы абстрагироваться от реализации. Мне не хочется видеть, как это устроено, мне хочется видеть, как это связано. Хотя, если проект прогоняется через генерилку после, то видеть уже как раз не хочется

Тоже не согласен. Кода там много - начинаешь разбираться - за деталями реализации теряются основы.

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

[the_deer_one]

crazy horse И прикинь, такой Уткин для своих личных проектов на одного человека всю эту ерунду поднимает? Да приложить просто .txt файлик к солюшену да и описать там всё.

[crazy horse]

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

crazy horse И прикинь, такой Уткин для своих личных проектов на одного человека всю эту ерунду поднимает? Да приложить просто .txt файлик к солюшену да и описать там всё.

Читаем вместе:

Цитата:
Лучшая документация это код.
Если проект о трех строках, то да.

К слову, мои личные проекты и демки имеют свойство использоваться в качестве демо для работодателей, а так же иногда тянутся в проекты в качестве движков/модулей. Грамотно построенные диаграммы всегда благоприятно сказываются на размерах заработной платы, самих шансах трудоустройства, демонстрируют навыки ведения проектов, сокращают время, необходимое на вхождение в проект сторонних разрабов. Так что лучше привыкать документировать должным образом даже "этот гребаный калькулятор".

[Человек_Борща]

Ну вот сижу выбираю под себя всяческие инструменты

для меня загадка, почему вы Delphi до сих пор не берете.
Диаграмму в код - 0 проблем, диаграмму из кода - легко. Под FPC код подогнать проблем не создаст.

Лучшая документация это код.
Если проект о трех строках, то да.

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

да же маленьким проектам иногда все эти 3 вещи нужны. Вы уверены что разберетесь в своем же коде через 3 года? А через 5? А вы точно язык программирования не измените с delphi на c++ а потом на Java? За время вы забудете то, что было когда-то, что не нужно вам сейчас.
Разборки со старым кодом - те самые 9 кругов ада. Особенно если код не твой, особенно если код твой, но ты был не опытным. Особенно если это было очень давно.

[Utkin]

Затем, чтобы абстрагироваться от реализации. Мне не хочется видеть, как это устроено, мне хочется видеть, как это связано. Хотя, если проект прогоняется через генерилку после, то видеть уже как раз не хочется

Вот, что-то как-то сходные симптомы.

для меня загадка, почему вы Delphi не берете.

Принципиально - это костыли. Ставить 1-2 гига мусора за тулзу это не совсем то решение, которое я хотел увидеть. Была как-то волна борьбы с пиратством - снес делфи. Счас вот хочу жить без него и дальше.

[the_deer_one]

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

[Utkin]

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

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

[Vapaamies]

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

Ставить 1-2 гига мусора за тулзу это не совсем то решение, которое я хотел увидеть.

Если альтернативное решение не находится, может это и не мусор?