IG
только бы синтаксис как-то упростить
Size: a a a
2021 January 14
ST
надо тогда по одному в строку писать. В принципе, удобно: аргументы и доки сразу в одном месте
для мультиарных функций вопрос, как писать
KC
ST
надо тогда по одному в строку писать. В принципе, удобно: аргументы и доки сразу в одном месте
иногда для аргумента ещё и примеры хочется привести и т.п.
одной строки может не хватить
одной строки может не хватить
ST
ну и для
x в двух местах одна и та же дока — неудобно поддерживатьKC
ну так ты уже писал что строкой дело не ограничивается, можно струкктурированные данные добавлять
KC
ну и для
x в двух местах одна и та же дока — неудобно поддерживатьтак она может быть и разная
KC
это же разные исплементации
ST
так она может быть и разная
ну, одинаковый по смыслу аргумент с разной документацией — звучит ещё более крипово
KC
так и смысл может быть разный, название переменной это просто символ
ST
ну, одинаковый по смыслу аргумент с разной документацией — звучит ещё более крипово
ещё давайте докстринг отдельный для каждой арности 😊
KC
я это и добавил в последнем примере)
ST
так и смысл может быть разный, название переменной это просто символ
всё может быть
я про классический случай, когда арность меняет количество аргументов, но не их смысл
я про классический случай, когда арность меняет количество аргументов, но не их смысл
ST
я это и добавил в последнем примере)
ну и как
doc это показывает?KC
ну мета понятия не имеет о смысле, в общем случае — не стоит на это полагаться
KC
ну и как
doc это показывает?документация на каждый вариант арити
ST
всё-таки более практично выглядит написание документации для функции «в целом», когда при добавлении арностей не начинаются пляски с бубном
можно было бы обычный :doc структурировать до аналога javadoc
от тулинга нужна только возможность ссылаться на имена аргументов, чтобы работала подстветка, рефакторинг и т.п.
а документация перед каждым аргументом — боль при чтении исходника
можно было бы обычный :doc структурировать до аналога javadoc
от тулинга нужна только возможность ссылаться на имена аргументов, чтобы работала подстветка, рефакторинг и т.п.
а документация перед каждым аргументом — боль при чтении исходника
ST
всё-таки более практично выглядит написание документации для функции «в целом», когда при добавлении арностей не начинаются пляски с бубном
можно было бы обычный :doc структурировать до аналога javadoc
от тулинга нужна только возможность ссылаться на имена аргументов, чтобы работала подстветка, рефакторинг и т.п.
а документация перед каждым аргументом — боль при чтении исходника
можно было бы обычный :doc структурировать до аналога javadoc
от тулинга нужна только возможность ссылаться на имена аргументов, чтобы работала подстветка, рефакторинг и т.п.
а документация перед каждым аргументом — боль при чтении исходника
«можно было бы обычный :doc структурировать» или :arglists
KC
всё-таки более практично выглядит написание документации для функции «в целом», когда при добавлении арностей не начинаются пляски с бубном
можно было бы обычный :doc структурировать до аналога javadoc
от тулинга нужна только возможность ссылаться на имена аргументов, чтобы работала подстветка, рефакторинг и т.п.
а документация перед каждым аргументом — боль при чтении исходника
можно было бы обычный :doc структурировать до аналога javadoc
от тулинга нужна только возможность ссылаться на имена аргументов, чтобы работала подстветка, рефакторинг и т.п.
а документация перед каждым аргументом — боль при чтении исходника
можно и так, но мне такой подход меньше нравится, пляски с бубном начнуться когда потребуется рефакторинг который потянет за собой не только изменения в описании аргументов но и изменение “не особо структурированных” докстрингов которые разнесены друг от друга