AN
Есть, но человек хочет шаблон док-коммента.
Так тоже есть
Size: a a a
2020 January 02
AM
Так тоже есть
Разве?
AN
вот только что проверил
AN
* @param spec fff [Int] и всплывающая подсказка с полным форматированием
AM
Generally, avoid using @param and @return tags. Instead, incorporate the description of parameters and return values directly into the documentation comment, and add links to parameters wherever they are mentioned. Use @param and @return only when a lengthy description is required which doesn't fit into the flow of the main text.
AN
Generally, avoid using @param and @return tags. Instead, incorporate the description of parameters and return values directly into the documentation comment, and add links to parameters wherever they are mentioned. Use @param and @return only when a lengthy description is required which doesn't fit into the flow of the main text.
Я обычно в @param пишу конвенции на параметры
k
оно видно в сигнатуре метода\функции. Зачем дублировать в доке?)
более того, даже в пхп уже так не делают)
более того, даже в пхп уже так не делают)
еще как делают)) все проекты более менее приличные документрируются так.. я вроде как немного в пхп шарю))
MM
еще как делают)) все проекты более менее приличные документрируются так.. я вроде как немного в пхп шарю))
ага, ведь очень много смысла в докблоке для
function calculate(int first, int second): int {}AM
* @param spec fff [Int] и всплывающая подсказка с полным форматированиемЯННП. Написал
/**, жмакнул энтер, шаблон со всеми параметрами не получил. Мы точно об одном и том же?AN
оно видно в сигнатуре метода\функции. Зачем дублировать в доке?)
более того, даже в пхп уже так не делают)
более того, даже в пхп уже так не делают)
Чтобы дока была читабельная.
k
в общем спасибо)) а то я сначала в заблуждение ввел)) а потом срач спровоцировал)) это у меня две недели выходных почти) я сижу читаю про разработку под андроид))
AN
ЯННП. Написал
/**, жмакнул энтер, шаблон со всеми параметрами не получил. Мы точно об одном и том же?Это включается в настройках. Но если вбить @param, то там автоподстановка имени параметра
AM
Это включается в настройках. Но если вбить @param, то там автоподстановка имени параметра
Да, но изначальный вопрос был о полном шаблоне.
Пойду поищу настройку)
Пойду поищу настройку)
AN
Да, но изначальный вопрос был о полном шаблоне.
Пойду поищу настройку)
Пойду поищу настройку)
Точно было, это уже кто-то спрашивал несколько раз
AM
Я просто вроде помню ишью с жалобой, что это не работает, и пояснением, что не сделали специально, чтобы не толкать к кдокам не по код-стайлу. Мб уже додавили.
k
ага, ведь очень много смысла в докблоке для
function calculate(int first, int second): int {}к каждому параметру не очень явному дописывается комментарии..
в классах прописываются property для геттеров, сеттеров, мутаторов) для связей и коллекций)) тогда идешка отлично помогает код писать) в общем удобно когда все документировано))
в классах прописываются property для геттеров, сеттеров, мутаторов) для связей и коллекций)) тогда идешка отлично помогает код писать) в общем удобно когда все документировано))
MM
к каждому параметру не очень явному дописывается комментарии..
в классах прописываются property для геттеров, сеттеров, мутаторов) для связей и коллекций)) тогда идешка отлично помогает код писать) в общем удобно когда все документировано))
в классах прописываются property для геттеров, сеттеров, мутаторов) для связей и коллекций)) тогда идешка отлично помогает код писать) в общем удобно когда все документировано))
велкам в тематические чаты. Тут мусорить не будем
AN
Я просто вроде помню ишью с жалобой, что это не работает, и пояснением, что не сделали специально, чтобы не толкать к кдокам не по код-стайлу. Мб уже додавили.
Может я конечно попутал...
AM
к каждому параметру не очень явному дописывается комментарии..
в классах прописываются property для геттеров, сеттеров, мутаторов) для связей и коллекций)) тогда идешка отлично помогает код писать) в общем удобно когда все документировано))
в классах прописываются property для геттеров, сеттеров, мутаторов) для связей и коллекций)) тогда идешка отлично помогает код писать) в общем удобно когда все документировано))
Ну вот в котлине для вышеуказанного метода стоит написать чёт вроде
/**
* Calculates something for [first] and [second] values.
*
* @throws MyCalculationException if [first] was 42.
*/
@throws придётся писать руками, checked exceptions в языке нет. Но это автоматически и не угадаешь. А вот @param / @returns, которые можно было бы вывести, тут не нужны.