Solidity и Ethereum, урок #60 | NapSpec, документация, Foundry, mdbook
В этом уроке мы поговорим о написании документации для кода Solidity и использованием формата NatSpec. Узнаем, как этот формат устроен, как его использовать, где и как смотреть сгенерированную документацию и как с помощью Foundry легко делать красивую онлайн-книгу со всеми доками.
Таймкоды:
00:00 Введение
00:30 Что такое NatSpec?
01:35 Теги для контрактов
03:00 Теги для переменных
03:50 Теги для событий
05:20 Теги для функций
07:45 Другие теги
09:40 Примечания в ABI
11:40 Генерируем доки в Foundry
13:00 Смотрим документацию локально (mdbook)
14:50 Заключение
Сообщество программистов
(программирование, языки программирования, курсы, книги, обзоры и др.)