Size: a a a

2019 August 30

AN

Alexander Nozik in Kotlin Moscow
Alexander Larin
я так понимаю, это какое-то одно из приложений к документации? вы в основной документации ссылаетесь на 34ый ли 19ый гост как стандарт оформления? и будь я потенциальным исполнителем я бы спросил, что делать если я использую в составе разрабатываемой системы какой то опенсорсный кусок, надо ли мне менять там нотацию комментариев, например?)
Там под часть требований stdlib java не подпадает
источник

Ⓢⓔⓡⓖ in Kotlin Moscow
У меня был коллега, требовал от всех на Си++ обязательно добавлять m_ к именам полей классов. (стиль Microsoft , слава инопланетянам, они сейчас от него отказались)
источник

Ⓢⓔⓡⓖ in Kotlin Moscow
А ещё классы начинать с буквы C, а интерфейсы с буквы I (последнее есть до сих пор)
источник

Ⓢⓔⓡⓖ in Kotlin Moscow
Ⓢⓔⓡⓖ
Мне нравятся, хорошие требования, только они в основном хороши для новичков, чтобы понять, что можно а что нельзя
про комментарии: хорошим стилем является вообще отстуствие комментариев, точнее, написание кода программы так, чтобы всё было понятно из методов и переменных, без лишних слов на человеческом языке
источник

Ⓢⓔⓡⓖ in Kotlin Moscow
В эпоху Agile требовать документировать всё подряд - безумство
источник

AN

Alexander Nozik in Kotlin Moscow
Ⓢⓔⓡⓖ
про комментарии: хорошим стилем является вообще отстуствие комментариев, точнее, написание кода программы так, чтобы всё было понятно из методов и переменных, без лишних слов на человеческом языке
Категорически не согласен. Считаю самодокументируемый код вредным мифом.
источник

КБ

Константин Буланов in Kotlin Moscow
Alexander Larin
я так понимаю, это какое-то одно из приложений к документации? вы в основной документации ссылаетесь на 34ый ли 19ый гост как стандарт оформления? и будь я потенциальным исполнителем я бы спросил, что делать если я использую в составе разрабатываемой системы какой то опенсорсный кусок, надо ли мне менять там нотацию комментариев, например?)
Так точно 34 ГОСТ. И то с апреля этого года РД 50 отменили. Вообще печаль по документации становится. Но код в документацию на бумажке не включаем. В ведомственный gitlab грузить заставляем. Насчёт опенсорса, требования идут к коду который пишется исполнителем, если код поставляется готовый по лицензионному соглашению то требования не предъявляются. Вроде так логично.
источник

SB

Sergey Barmin in Kotlin Moscow
Ⓢⓔⓡⓖ
В эпоху Agile требовать документировать всё подряд - безумство
Выделить отдельный спринт на документирование)
источник

AN

Alexander Nozik in Kotlin Moscow
Если пишите для себя в замкнутой команде, можете писать докуменацию как угодно. Но если это либа или есть большая текучка кадров, то без документации нельзя.
источник

SM

Sergey Morgunov in Kotlin Moscow
Alexander Nozik
Категорически не согласен. Считаю самодокументируемый код вредным мифом.
О да 👍 Иной раз на одну строчку нужно написать целый параграф, чтобы объяснить какого хрена оно так, а не иначе 😀 Да ещё с ссылочкой на какую-нибудь статью где это объясняется ещё более подробно 😀 И чем ближе к системному коду, тем больше нужды в таких комментах 😀
источник

КБ

Константин Буланов in Kotlin Moscow
Alexander Nozik
Если пишите для себя в замкнутой команде, можете писать докуменацию как угодно. Но если это либа или есть большая текучка кадров, то без документации нельзя.
Плюсую. Ещё это полезно если разработчик системы одна команда, а сопровождает другая.
источник

AN

Alexander Nozik in Kotlin Moscow
Sergey Morgunov
О да 👍 Иной раз на одну строчку нужно написать целый параграф, чтобы объяснить какого хрена оно так, а не иначе 😀 Да ещё с ссылочкой на какую-нибудь статью где это объясняется ещё более подробно 😀 И чем ближе к системному коду, тем больше нужды в таких комментах 😀
Я обычно пишу хотя бы строчку по поводу того, что метод делает.
источник

Ⓢⓔⓡⓖ in Kotlin Moscow
Ну и почему бы это (то, что он делает), не закодировать в его названии?
источник

Ⓢⓔⓡⓖ in Kotlin Moscow
Закодировать = подобрать краткие и точные английские слова и перевести в camel case
источник

Ⓢⓔⓡⓖ in Kotlin Moscow
Хотя я понимаю, что не всем быть Антонами Чеховыми.
источник

AN

Alexander Nozik in Kotlin Moscow
Ⓢⓔⓡⓖ
Ну и почему бы это (то, что он делает), не закодировать в его названии?
Нельзя все закодировать в названии. Одному это может быть очевидно, другому нет. Соглашения на параметры? Выкидываемые ошибки? тред сейфети?
источник

Ⓢⓔⓡⓖ in Kotlin Moscow
И даже хотя бы Львами Толстыми не каждый сможет, а самое сложное - подобрать точные слова для описания того, что он делает
источник

SM

Sergey Morgunov in Kotlin Moscow
Ⓢⓔⓡⓖ
И даже хотя бы Львами Толстыми не каждый сможет, а самое сложное - подобрать точные слова для описания того, что он делает
Иногда важно не то, что он делает, а почему он делает это именно так, а не иначе. И это ни в каком названии не опишешь 😀
источник

КБ

Константин Буланов in Kotlin Moscow
Sergey Morgunov
Иногда важно не то, что он делает, а почему он делает это именно так, а не иначе. И это ни в каком названии не опишешь 😀
Такую экспертизу ведомство провести не может. У нас экспертиза будет дороже самих работ :)
источник

AN

Alexander Nozik in Kotlin Moscow
ключевые публичные API должны быть с коментами хотя бы даже для того, чтобы кдоки читабельные были
источник