Size: a a a

Kotlin Community

2020 January 02

AM

Andrew Mikhaylov in Kotlin Community
Ctrl+Q на вызове метода при надобности даст это всё прочитать, типы и по Ctrl+P доступны, если есть понимание, что метод делает, и нужны только параметры с типами.
источник

MM

Maksim Masiukevich in Kotlin Community
я бы для такого случая доку в принципе не писал. Ни в пхп (ибо все типы выведены), ни в котлине. Играть в КЭПА - такое себе.

докблоки в пхп - следствие системы типов (отсутствия?). Нельзя взять и написать Map<String, Int>
источник

SZ

Sergey Zolotov in Kotlin Community
Maksim Masiukevich
я бы для такого случая доку в принципе не писал. Ни в пхп (ибо все типы выведены), ни в котлине. Играть в КЭПА - такое себе.

докблоки в пхп - следствие системы типов (отсутствия?). Нельзя взять и написать Map<String, Int>
ты хоть в пхп чатик не превращай тут
источник

AN

Alexander Nozik in Kotlin Community
Andrew Mikhaylov
Ну вот в котлине для вышеуказанного метода стоит написать чёт вроде
/**
* Calculates something for [first] and [second] values.
*
* @throws MyCalculationException if [first] was 42.
*/

@throws придётся писать руками, checked exceptions в языке нет. Но это автоматически и не угадаешь. А вот @param / @returns, которые можно было бы вывести, тут не нужны.
Ну это я согласен, что правильно. Я использую парамы и ретерны только когда там какой-то специфический контракт
источник

MM

Maksim Masiukevich in Kotlin Community
Sergey Zolotov
ты хоть в пхп чатик не превращай тут
эт не я превращаю)
источник

AM

Andrew Mikhaylov in Kotlin Community
Sergey Zolotov
ты хоть в пхп чатик не превращай тут
Да мы вроде и не о ПХП, а о док-комментах в целом.
источник

AN

Alexander Nozik in Kotlin Community
Maksim Masiukevich
я бы для такого случая доку в принципе не писал. Ни в пхп (ибо все типы выведены), ни в котлине. Играть в КЭПА - такое себе.

докблоки в пхп - следствие системы типов (отсутствия?). Нельзя взять и написать Map<String, Int>
Самодокументирующийся код - это весьма вредный миф
источник

MM

Maksim Masiukevich in Kotlin Community
Alexander Nozik
Самодокументирующийся код - это весьма вредный миф
мусорные комменты, в целом, тоже
источник

AN

Alexander Nozik in Kotlin Community
Maksim Masiukevich
мусорные комменты, в целом, тоже
Мусорные комменты - это которые? Пример можно?
источник

MM

Maksim Masiukevich in Kotlin Community
Andrew Mikhaylov
Ну вот в котлине для вышеуказанного метода стоит написать чёт вроде
/**
* Calculates something for [first] and [second] values.
*
* @throws MyCalculationException if [first] was 42.
*/

@throws придётся писать руками, checked exceptions в языке нет. Но это автоматически и не угадаешь. А вот @param / @returns, которые можно было бы вывести, тут не нужны.
вот
источник

MM

Maksim Masiukevich in Kotlin Community
эксепшен разве что оставить можно) остальное там не нужно
источник

AN

Alexander Nozik in Kotlin Community
Коммент на сеттере, что сеттер сетает - это мусор, согласен, но по ссылке просто пример и как правило такой коммент должен быть
источник

SZ

Sergey Zolotov in Kotlin Community
я б за пример брал std либу котлина
источник

SZ

Sergey Zolotov in Kotlin Community
или корутин
источник

AM

Andrew Mikhaylov in Kotlin Community
Простите, а что я должен был написать на ваше описание метода? Само собой, если бы мы говорили предметно, можно было бы адекватное описание на пару строк сделать, возможно, упоминая краевые значения, или что-то в этом духе.
источник

AN

Alexander Nozik in Kotlin Community
Вообще комменты должны быть на всех публичных методах. Просто потому что по ним кдок генериться будет
источник

MM

Maksim Masiukevich in Kotlin Community
Alexander Nozik
Коммент на сеттере, что сеттер сетает - это мусор, согласен, но по ссылке просто пример и как правило такой коммент должен быть
я не против комментов в принципе, просто здравый смысл надо подключать. Это коммент ради коммента
источник

SZ

Sergey Zolotov in Kotlin Community
Alexander Nozik
Вообще комменты должны быть на всех публичных методах. Просто потому что по ним кдок генериться будет
если это внутренние либы или часть приложения, то какой смысл?
источник

MM

Maksim Masiukevich in Kotlin Community
Andrew Mikhaylov
Простите, а что я должен был написать на ваше описание метода? Само собой, если бы мы говорили предметно, можно было бы адекватное описание на пару строк сделать, возможно, упоминая краевые значения, или что-то в этом духе.
дык эт не упрёк, если что)
источник

AN

Alexander Nozik in Kotlin Community
Sergey Zolotov
если это внутренние либы или часть приложения, то какой смысл?
Если у кода строго один пользователь, то не обязательно
источник