Стандарт оформления кода разрабатываемых модулей [closed]


#1

Предлагаю обсудить стандарт кода разрабатываемых модулей. Точнее, описать правила оформления кода, наподобие данного. @Admin, если есть такой документ, либо соглашения уже приняты в устной или другой форме, то можете их показать?

На мой взгляд, указанный по ссылке стандарты оформления кода, описаны достаточно хорошо, но требуют внесения нескольких правок (в контексте PascalABC.Net):

  1. Все имена классов или записей имеют префикс T (от слова type): TPoint. Цель: избежание конфликтов имён.
  2. Все имена полей начинаются с префикса f (от слова field) и пишутся в Pascal Case: fName.
  3. Именования переменных (включая глобальные, пишутся в Camel Pase).

#2

Я, например, не согласен с некоторыми положениями.


#3

Я выше написал, что можно подправить. Но, я рад выслушать Ваше мнение по этому поводу.


#4

А вот с этим не согласен категорически!

Как только вижу такой код, появляется ощущения древних версий (Delphi, FreePascal).

То же самое.

Можно подробнее?


#5

Можно, например:

begin
  var someName: byte; // Вместо var SomeName: byte;
end.

.


#6

Значит и с этим не согласен.


#7

Предлагайте альтернативы. И аргументы почему Вы были против этого.


#8

И так практически никто ничего делать не хочет реального - только советы и пожелания, а временами даже чуть ли требования. А если еще те единицы, которые готовы чем-то помочь, загнать попытаться в “стандарт”… Наивно и смешно. Для начала придется разработчикам весь компилятор в такой “стандарт” переписать.


#9

Давайте сначала обсудим стандарт. Потом посмотрим на реакцию разработчиков. Их мнение тоже должно учитываться.


#10

Писать все слова с большой буквы.

var MyName: Int32;

Писать имена классов, структур и перечислений БЕЗ T и начиная каждое слово большой буквой:

Type MyClass = sealed class
End;

Поля не имеют лишних знаков (f).

Public MyField: Int32;

#11

Их мнение - основное. А вот мнение остальных они могут учитывать. Если сочтут нужным.


#12

Я вообще сомневаюсь, что такая жёсткая стандартизация нужна.


#13

Мнение всех учитывается. Но решение принимается разработчиками. Я бы сказал так.


#14

Так правильнее.


#15
type
  TSomeClass = class
  private
    _x: byte;
  
  public
    property X: byte read _x;
  end;
  
begin
end.

Я предлагал f как префикс по той причине, что символ подчеркивания выглядит коряво в названиях приватных полей.


#16

Еще раз: пока разработчики весь компилятор не перепишут в “стандарт”, они не имеют морального права требовать этого от остальных, кто вызывается им помогать.


#17

С другой стороны, если кто-то напишет на C# что-то в таком роде:

public sealed class TMyClass{
}

вопросов будет очень много :smile:


#18

Это как понять?


#19

Я не предлагал переписать компилятор в стандарт. Я предложил переписать обучающие модули в стандарт (при возможности). На счёт компилятора - он не на PascalABC.Net пишется, так что там правильнее стандарты кода C# применять.


#20

Но он сразу бросается в глаза. Не просто так в C/C++/C# пишут именно так. Читабельность выше. Касательно TSomeClass - вообще не понятно, зачем T.