8 Соглашения по написанию кода
redex2000 edited this page 3 years ago

Общие положения

Т.к. на платформе используется стиль Go, то в основном все соглашения по проекту базируются на соглашениях языка Go.

Тем более что сам язык активно принуждает к использованию правил написания кода.

Также желательно придерживаться некоторых соглашений gitea.

Правила именования

  1. При выборе названий терминов нужно придерживаться единого языка деятельностной платформы, если этих терминов (методов, структур и тд) ещё нет в gitea.
    1. Например, User уже есть, поэтому используем User.
    2. А вот ресурса ещё нет, поэтому используем термин Resource.
  2. Именовать нужно по правилам Go.
  3. Также придерживаться лучших практик, см. наши общие правила именования.