2008-11-04 9 views
17

Jakich dokumentów standardów kodowania Delphi śledzisz?Jakie dokumenty dotyczące standardów kodowania Delphi są przestrzegane?

Nasza firma poszukuje lepszych standardów kodowania, aby poprawić czytelność kodu, jego poprawność i łatwość konserwacji. Natknęliśmy się na "Object Pascal Style Guide" firmy CodeGear, ale od dawna nie była ona poruszana i wyobrażam sobie, że wiele osób wprowadziło pewne ulepszenia lub dodatki. Natknąłem się na niektóre opublikowane odmiany i inne dokumenty, które wymienię poniżej.

NB: Robię , a nie chcę rozpocząć wojnę w stylu. Chcę tylko wiedzieć, jakie standardy przestrzegasz i dlaczego.

Dzięki.


UPDATE: Cóż, "JCL Delphi Język Style Guide" wydaje się być wyraźnym zwycięzcą! Dzięki!

Odpowiedz

17

JCL Delphi Język Style Guide

(Rozszerzenie CodeGear w „Object Pascal Style Guide”)

http://jcl.delphi-jedi.org/documents/styleguide.html

(Dzięki Jeroen Pluimers dla zauważając, że oryginalny link borland.com umarł i za dostarczenie nowego linku.)

+0

Przeważnie podążam za tym standardem. Mój wyjątek polega na tym, że podczas ustawiania komponentów edycyjnych zwykle poprzedzam je ed (nie ma znaczenia, czy jest to pole edycji, notatki lub listy kombi). Dla przycisków I przedrostkiem btn. – skamradt

+2

Link w odpowiedzi już nie działa, ale myślę, że jest to artykuł, który masz na myśli: http://jcl.delphi-jedi.org/documents/styleguide.html, z tym jako dobrym dodatkowym zasobem http://jvcl.delphi-jedi.org/StyleGuide.htm –

1

JVCL-rozszerzonej wersji CodeGear w „Object Pascal Style Guide”

(to wygląda tak samo jak w wersji JCL, do mnie.)

http://jvcl.delphi-jedi.org/StyleGuide.htm

(Podziękowania dla Jeroen Pluimers, za dostarczenie nowego linku.)

2

Econos - („Przewodnik standardy kodowania dokumentów Delphi 4 Program” napisami) Standardy kodowania dokumentu

http://www.econos.de/delphi/cs.html

+0

Ach, dobrzy dawni mistrzowie Xavier Pacheco, Steve Teixeira i Stefan Hoffmeister! Sprawdzałem pierwsze dwa, ale zastanawiam się, co stało się ze Stefanem. –

0

To naprawdę nie ma znaczenia, tak długo, jak wybrać jedną i trzymać się go.Standard kodowania jest jak dialekt i tak długo, jak wszyscy członkowie zespołu mówią tym samym dialektem, wszystko w porządku.

To powiedziawszy, dlaczego nie wybrać tego samego standardu, co biblioteka środowiska wykonawczego (VCL) i korzystanie z dokumentacji? Wtedy wszyscy będą mówić tym samym dialektem, a będziesz miał łatwiejszy odczyt kodu biblioteki środowiska wykonawczego. Istnieje wiele przykładów kodu ilustrujących konwencje kodowania.

+0

To bardzo dobry punkt, a ja doceniam twoją pracę. Dzięki! To powiedziawszy, chcemy wybrać standard, który zmierza w kierunku "kompletnej" strony, więc dokument VCL może nie być najlepszy. –

+0

Moja osobista perswazja polega na tym, że mniej znaczy więcej, a na koniec zasady, które można uchwycić w dokumencie standardowym, są znacznie mniej ważne dla łatwości konserwacji niż postawa i doświadczenie programisty. – Jozz

0

Może występować tendencja do nadmiernego konstruowania standardów kodowania do tego stopnia, że ​​stają na drodze pisania kodu.

Zgadzam się z komentarzem Jozz. Możesz spojrzeć na wszystkie zalecane standardy, wybrać jedną i wymusić na swoich programistach lub możesz zaangażować swój zespół w proces.

Z mojego doświadczenia wynika, że ​​najlepszym sposobem na zaangażowanie zespołu jest zaproponowanie zespołowi pomysłu i korzyści wynikających z adopcji. Twój dotychczasowy talent jest Twoim najlepszym zasobem. Podobnie, mogą być twoim największym wrogiem, jeśli zmusisz ich do wejścia na ścieżkę, na którą nie kupują.

Więc spójrz na istniejących wariantów kodowania i dostać się do zespołu razem dla niektórych żywych dyskusji na temat:

  • o przyczynach przyjęcia standardu kodowania.
  • Istotne uwarunkowania w standaryzacji.
  • Uszkodzenie wszelkich niepewności w zespole otaczającym ten problem.
  • Ustalanie punktu zgody. Co jest ważne, a co nie.
  • Ustanowienie niektórych celów korporacyjnych, aby wszyscy mieli poczucie, że dążą do wspólnego celu.
  • Poproś zespół, aby sam sprzedał korzyści z normalizacji.

Najważniejszym celem musi być ustanowienie "standardu", który najlepiej służy Twojemu zespołowi i Twojej firmie.

0

Z jakiegoś niegrzecznego historycznego powodu standardem kodowania w mojej pracy jest posiadanie wszystkich słów kluczowych pisanych wielkimi literami, zarówno w delphi jak i sql. Dzięki Bogu za zamek w czapce.

Powiązane problemy