Комментарии удалены?

[gudzon]

Добрый день!
По ходу программирования в Axapta появилось предположение что кто-то автоматически удалил все комментарии из кода? Кто? Зачем? На каком этапе? Это только в российской функциональности?

[Андре]

Хм... и на основе чего возникло такое предположение, если не секрет ?
В основном код достаточно прозрачен и понятен без комментариев, за исключением нескольких мест, где действительно бывает полезна помошь - например, книги покупок/продаж.
Комментарии удалялись вряд ли - так как если удалять, то все - а я встречал комментарии как разаботчиков российского mbs, так и международного (включая комментарии на датском ).

[George Nordic]

На самом деле, это близко к истине. Дело в том, что многие баги, поправленные локализаторами (основное кол-во - росийскими ) были поправлены уже MBS на более низких слоях. Так что вместо комментариев //EVGL.... //Valu... //GrVe... //ANVA... и т.п. Теперь либо просто прижившийся код, либо чужие или безличные комментарии... // RU-477-814-QBHL, // SP3 DK-68-603-CCR9....


С Уважением,
Георгий

[gudzon]

Quote:

Изначально опубликовано Андре
Хм... и на основе чего возникло такое предположение, если не секрет ?
В основном код достаточно прозрачен и понятен без комментариев, за исключением нескольких мест, где действительно бывает полезна помошь - например, книги покупок/продаж.
Комментарии удалялись вряд ли - так как если удалять, то все - а я встречал комментарии как разаботчиков российского mbs, так и международного (включая комментарии на датском ).

Код становиться прозрачным после очень тесного знакомства с Axapta.
Дело ведь не в понимании кода вообще, а в элементарной экономии времени разработчика. Могу предположить, что кой кому это не выгодно...
С чего я взял что удалили комментарии? Почему в ключевых местах кода ( перед функциями, в начале циклов... ) стоят пустые строки? Только лишь для удобства?
Вряд ли....

[Hamster]

>кто-то автоматически удалил все комментарии из кода? Кто? Зачем?

А чтоб потом никто не узнал насколько хорошо KURA или EVGL знали Axapta

[komar]

Quote:

Изначально опубликовано Hamster
>кто-то автоматически удалил все комментарии из кода? Кто? Зачем?

А чтоб потом никто не узнал насколько хорошо KURA или EVGL знали Axapta

Понится, в одной компании, в которой мне довелось работать, KURA считался чем-то вроде злого духа - покровителя граблей :-))) все из-за опрометчиво оставленных подписей в комментариях к наиболее выдающимся участкам локализации образца версии 2.1-2.5

[mazzy]

Quote:

Изначально опубликовано gudzon
Добрый день!
По ходу программирования в Axapta появилось предположение что кто-то автоматически удалил все комментарии из кода? Кто? Зачем? На каком этапе? Это только в российской функциональности?

Комментарии есть, конечно.
Info.startup()
SysApplCheck.argumentThePaths()
SysCheckList.*
SysListPanel.addData
и т.п.

Где-то были даже разыернутые описания концепции работы.

Почему комментариев так мало?
Просто исходные разработчики свято верили в рефакторинг и перекрестные ссылки.
http://w8.platonoff.com/refactoring/

Один из постулатов рефакторинга говорит, что правильному коду не нужны комментарии. Код должен быть таким, чтобы его можно было читать и понимать как обычный текст.

Надо сказать, что если оставить один слой sys, то именно так и происходит.
Когда слоев много (много объектов), то уже необходимы не комментарии к коду, а описание СЕМЕЙСТВА классов. Так например, для четкой работы программиста необходимо описание концепции работы семейства LedgerVoucher.

А вот такой документации в Аксапте чертовски мало. Именно из-за того, что разрабочики свято верили в рефакторинг.

С российской функциональностью было чуть по-другому...

[Ruff]

Quote:

Изначально опубликовано mazzy

Один из постулатов рефакторинга говорит, что правильному коду не нужны комментарии. Код должен быть таким, чтобы его можно было читать и понимать как обычный текст.

Надо сказать, что если оставить один слой sys, то именно так и происходит.

Угу! А еще один из постулатов рефакторинга гласит следующее:

Quote:

Extract Method
You have a code fragment that can be grouped together.
Turn the fragment into a method whose name explains the purpose of the method

Теперь берем метод \Classes\CustVendSettle\SettleNow, оставляем слой SYS и смотрим:
1. В начале метода огромный комментарий (см. первый постулат )
2. Код метода состоит из 620-и строк (см. второй постулат)

P.S. Сергей, только не говори, что исключение подтверждает правило. Аксапта с рефакторингом явно не дружат

[George Nordic]

Как раз это - именно исключение.
Кстати говоря, это самый длинный метод во всей Axapta. Если говорить честно, то разработчики все-таки старались разбить код на множество мелких методов. Иногда даже черезчур

С Уважением,
Георгий.

[mazzy]

Quote:

Изначально опубликовано Ruff
Теперь берем метод \Classes\CustVendSettle\SettleNow, оставляем слой SYS и смотрим:
1. В начале метода огромный комментарий (см. первый постулат )
2. Код метода состоит из 620-и строк (см. второй постулат)

P.S. Сергей, только не говори, что исключение подтверждает правило. Аксапта с рефакторингом явно не дружат

Как раз скажу. Как раз исключение и как раз подтверждает.
Для того, чтобы это понять необходомо посмотреть историю этого метода.
Начиная с версии 2.1

В том то и дело, что со временем команда сменилась.
И теперь мало кто вообще понимает что и почему там делается...
Поэтому документация очень и очень нужна.

[Андре]

Quote:

Для того, чтобы это понять необходомо посмотреть историю этого метода.

Угу. Этот код кем только не правился

[levsha]

Quote:

Изначально опубликовано mazzy

Где-то были даже разыернутые описания концепции работы.

в 2.5 таким развернутым описанием мог похвастать класс RunBase

Quote:

Изначально опубликовано mazzy

Один из постулатов рефакторинга говорит, что правильному коду не нужны комментарии. Код должен быть таким, чтобы его можно было читать и понимать как обычный текст.

в приведенной Вами ссылке ничего похожего на первую часть постулата я не увидел... Более того, для прояснения сути присходящего постоянно приводятся uml-диаграммы, которые тем более в код никто помещать не будет. Постулат об отсутствии комментариев больше соответствует идеологии extreme programming, которая стала так популярна у отечественных девелоперов в том числе и благодаря такому заявлению.

Quote:

Изначально опубликовано mazzy

Надо сказать, что если оставить один слой sys, то именно так и происходит.
Когда слоев много (много объектов), то уже необходимы не комментарии к коду, а описание СЕМЕЙСТВА классов. Так например, для четкой работы программиста необходимо описание концепции работы семейства LedgerVoucher.

А вот такой документации в Аксапте чертовски мало. Именно из-за того, что разрабочики свято верили в рефакторинг.

Действительно, много объектов, которые ни каким образом не структурированы...
Верили бы разработчики свято в рефакторинг, то заложили бы в язык хотя бы разбиение классов на пакеты. А то получается, что и на пакеты не разбить и иерархия классов выше третьего порядка трудно реализуема(с помощью принятой в аксапте практики добавлять к имени предка "_ТакойтоПотомок" в названии класса-потомка) от того, что имя класса ограничено 35-ю символами... Скорее разработчики свято верили в непогрешимость и универсальность своего кода...

[Андре]

Quote:

Постулат об отсутствии комментариев больше соответствует идеологии extreme programming

Если я не позабыл, то рефакторинг является составляющей XP. Так же как и парное программирование и unit-тесты.

[mazzy]

Quote:

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

В приведенной ссылке перевод только первой главы.
Найдите книгу.

Рефакторинг и экстремальное программирование - две очень близко идущие ветви.
Но это уже другая тема. Откройте новую, если вам это интересно.

Quote:

Изначально опубликовано levsha
Скорее разработчики свято верили в непогрешимость и универсальность своего кода...

Или так.


Анекдот.
Сталинские времена. Просмотр в закрытом кремлевском зале нового фильма. Присутствуют: сталин, министр культуры, режиссер, другие отвественные лица. После просмотра все ждут мнения главного.
Сталин: - А почему у главного героя усы как у вождя мирового пролетариата?
... молчание ...
Сталин: - Значит так, актера расстрелять, режиссера расстрелять, министра культуры...
Министр культуры: - Может главному герою усы сбрить?
Сталин: - Или так.

[Андре]

Quote:

Более того, для прояснения сути присходящего постоянно приводятся uml-диаграммы

А вот применение диаграмм - это уже больше к RUP относится. То есть, и в xp не запрещается их использовать, но там действует примерно такое правило: "если есть подозрение (хоть малейшее), что данный документ/схема/диаграмма/коментарий не будут ни разу востребованы - то и делать их не стоит".

[levsha]

Quote:

Изначально опубликовано Андре

там действует примерно такое правило: "если есть подозрение (хоть малейшее), что данный документ/схема/диаграмма/коментарий не будут ни разу востребованы - то и делать их не стоит".

судя по всему, именно в этом были уверены разработчики Аксапты...

[Alks]

Мне не верится что аксапта (пусть даже когда она была еще 1.0, или даже 0.666) была разработана без единой строчки документирвания структур и связей таблиц, концепций модулей и иерархии их классов и логики их работы.
Судя по тому сколько строк кода в аксапте и тому что она ЕЩЕ РАБОТАЕТ, тонны такой документации всё таки где то существуют. Не может быть что MBS-овцы передают друг другу и следующим поколениям своих разработчиков такие вещи исключительно в устно-сказательной форме.
Почему же они ею не делятся? Думаю это глупый вопрос.

[George Nordic]

http://w8.platonoff.com/refactoring/

Рефакторинг! Утонем в комментариях. Код - это и есть в данном случае комментарий + грамотное название методов и классов...
Другое дело, что в паре мест они действительно не помешеют...

С Уважением,
Георгий.

[Hamster]

2 Alks

В европейской штаб-хате MBS наверняка стоит Rose.
И наверняка все закодено в UML, и есть даже драйвер для X++

Не может не быть...

[mazzy]

Quote:

Изначально опубликовано Alks
Мне не верится что аксапта (пусть даже когда она была еще 1.0, или даже 0.666) была разработана без единой строчки документирвания структур и связей таблиц, концепций модулей и иерархии их классов и логики их работы.
Судя по тому сколько строк кода в аксапте и тому что она ЕЩЕ РАБОТАЕТ, тонны такой документации всё таки где то существуют. Не может быть что MBS-овцы передают друг другу и следующим поколениям своих разработчиков такие вещи исключительно в устно-сказательной форме.
Почему же они ею не делятся? Думаю это глупый вопрос.

О... как я верил в это еще год назад.
Фиг, нет у них такой документации.
Действительно нет.