MoonSHRD / UniversalNFTMarketplace

Universal NFT Marketplace
Other
9 stars 0 forks source link

Style Guide [draft] #70

Open JackBekket opened 3 years ago

JackBekket commented 3 years ago

Few commentaries about code style we use in this repo:

Variables

мы пишем _variable когда это низкоуровневая (глобальная) переменная, variable_ когда это инпут типа как дефис слева — наше, дефис справа — приходит из вне

Function Names

по названиям функций _functionName — когда это низкоуровневая функция (internal/приватная/наследуемая) функция, FunctionName когда это публично доступная функция Таким образом например Mint будет публично доступной функцией из нашего контракта, _mint будет низкоуровневой функцией наследуемой из OZ

Getters

еще про геттеры, любые функции геттеров называем как Get..., что бы другим разрабам было удобнее вызывать геттеры из IDE