Это руководство предназначено для обзора основных соглашений о написание Solidity кода. Цель этого раздела познакомить с общепринятыми сообществом соглашениями.
Важно! В любом случае это только рекомендация. Нет смысла вырабатывать стиль написания кода, который будет соответствовать одному из гайдов. Тем более, что гайды могут предлагать разные принципы и подходы. Часто гайды могут противоречить друг другу. И это нормально. Поэтому мы считаем, что самое главное - это написание последовательного и логичного кода. Любые отступления в угоду улучшения читабельности кода приветствуются. Но не стоит злоупотреблять такими отступлениями. Всегда нужно помнить, что блокчейн является прозрачным и другим разработчикам или пользователям будет приятно читать понятный и простой код вашего смарт-контракта. Это однозначно повысит уровень доверия к твоему контракту.
- Упрощенная выжимка основных правил
- Официальная документация Solidity
- Расширение официальной документации от команды Primitive
- Стандарты для кода смарт-контрактов от Kleros
- OpenZeppelin. Компания, которая разрабатывает стандарты для безопасных блокчейн приложений интересна с точки зрения написания кода в первую очередь.
- Chainlink в своих смарт-контрактах использует особое именование переменных.
- Compound
- Uniswap
- Aave