День 2 — Комментарии и NatSpec

Это день 2 из 30 в серии Solidity.
Сегодня я узнал о комментариях и формате NatSpec в Solidity.

Solidity поддерживает как комментарии в стиле C, так и в стиле C++, таким образом.

  • Любой текст между символом // и концом строки рассматривается как комментарий и игнорируется компилятором Solidity.
  • Любой текст между символами /и/ рассматривается как комментарий. Это может охватывать несколько строк.
// This is a Single Line Comment

Вход в полноэкранный режим Выход из полноэкранного режима
/*

This is A Multi-Line Comment 
It can also Include Emojis 😃

*/

Войти в полноэкранный режим Выход из полноэкранного режима

Формат NatSpec

Контракты Solidity могут использовать специальную форму комментариев для предоставления подробной документации для функций, возвращаемых переменных и многого другого. Эта специальная форма называется Ethereum Natural Language Specification Format (NatSpec).

/// This is NatSpec Single Line Comment
/// @title This is a Title
/// @author Author Name
/// @dev Please use this in this way
Вход в полноэкранный режим Выход из полноэкранного режима
/**
This is NatSpec Multi Line comment
This is Line 2
And so on....
*/
Войти в полноэкранный режим Выход из полноэкранного режима

Подробнее о NatSpec — здесь

Envoy-VC / 30-Days-of-Solidity

30 Days of Solidity — пошаговое руководство по изучению разработки смарт-контрактов.

Оцените статью
Procodings.ru
Добавить комментарий