Вопросы по теме 'code-documentation'

Как лучше всего обрабатывать / форматировать Javadoc и аннотации в коде?
Я просмотрел этот форум, погуглил и не знаю, как лучше всего обрабатывать документацию Javadoc и аннотации, которые появляются вместе в одном классе. Из того, что я вижу из документации Sun / Oracle, они, кажется, предлагают (хотя я не могу найти...
1754 просмотров

Как описать аргументы функции в языках с динамической типизацией?
Мой вопрос больше ориентирован на Python, но также может касаться JavaScript или других языков сценариев. Я обычно разрабатываю со статически типизированными языками (Java, C++, ActionScript, ...). Мне нравится время от времени использовать...
369 просмотров

Документация по полимерным веб-компонентам
Где я могу найти документацию для веб-компонентов, управляемых PolymerElements? Я здесь: https://www.webcomponents.org/element/PolymerElements/paper-dialog , и на странице написано, что нужно посмотреть Документы, но нет ссылки. Я просто хочу...
43 просмотров
schedule 07.01.2023

Документ YARD - как документировать тип класса, ориентируясь на его родительский класс
Предположим, у меня есть следующее class AbstractClass; end class ConcreteClass1 < AbstractClass; end class ConcreteClass2 < AbstractClass; end Как задокументировать возвращаемое значение, которое возвращает экземпляр класса класса,...
88 просмотров
schedule 05.11.2022

Использование декоратора класса @Injectable на сервисе, предоставляемом модулем @Global (в официальной документации)
Вопросы о ConfigService в документации : https : // docs .nestjs.com / Technics / configuration # service Смотрите определение класса там: export class ConfigService { /* ... */ } Почему нет декоратора @Injectable ? Есть причина...
93 просмотров
schedule 29.07.2022

Могу ли я определить, какие ошибки вызовет функция при наборе текста?
Допустим, у меня есть функция: def foo(integer: int) -> int: if integer < 0: raise ValueError("The integer must be positive") return integer * 2 Если я посмотрю на сигнатуру этой функции, она только скажет мне, что она...
47 просмотров

Как безопасно отправить заказ корзины и информацию о платеже в PayPal на PHP?
Я просматривал следующее руководство PayPal (поскольку это единственный доступный документ, в котором я смог найти подробные сведения о реализации PHP и может обрабатывать корзину / корзину / несколько покупок):...
54 просмотров

Правильное статическое использование с BorderLayout
Документацию, которую я прочитал для утверждения BorderLayout, лучше всего использовать PAGE_END , PAGE_START , LINE_START , LINE_END и CENTER . ( https://docs.oracle.com/javase/tutorial/uiswing/layout/border.html ) Однако я также нашел...
30 просмотров

Как получить упрощенный ReturnType через MethodInfo?
Используя отражение для получения MethodInfo, я хочу получить более удобную для пользователя версию ReturnType для некоторой самостоятельной документации. В настоящее время этот methodInfo.ReturnType.Name возвращает что-то вроде Dictionary 2 or...
32 просмотров