2008-11-04 9 views
17

Bạn làm theo các tài liệu tiêu chuẩn mã hóa Delphi nào?Bạn làm theo các tài liệu tiêu chuẩn mã hóa Delphi nào?

Công ty chúng tôi đang xem xét đưa ra một số tiêu chuẩn mã hóa tốt hơn tại chỗ, để cải thiện khả năng đọc, khả năng đánh giá và khả năng bảo trì của mã của chúng tôi. Chúng tôi đã xem "Hướng dẫn về phong cách đối tượng Pascal" của CodeGear, nhưng nó không được xúc động trong một thời gian và tôi tưởng tượng một số người đã thực hiện một số cải tiến hoặc bổ sung tại địa phương. Tôi đã xem xét một số biến thể được xuất bản và các tài liệu khác mà tôi sẽ liệt kê bên dưới.

NB: Tôi làm không phải muốn bắt đầu cuộc chiến kiểu. Tôi chỉ muốn biết bạn tuân theo những tiêu chuẩn nào và tại sao.

Cảm ơn.


CẬP NHẬT: Vâng, "JCL Delphi Language Style Guide" có vẻ là người chiến thắng rõ ràng! Cảm ơn!

Trả lời

17

JCL Delphi Ngôn ngữ Style Guide

(Một phần mở rộng của “Object Pascal Style Guide” của CodeGear)

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

(Cảm ơn, Jeroen Pluimers, cho nhận thấy rằng liên kết borland.com gốc đã chết và để cung cấp những liên kết mới.)

phiên bản
+0

Chủ yếu là tôi tuân theo tiêu chuẩn này. Ngoại lệ của tôi là khi đặt xuống các thành phần chỉnh sửa, tôi thường đặt tiền tố cho chúng với ed (không quan trọng nếu hộp chỉnh sửa, ghi nhớ hoặc combo của nó). Đối với các nút I tiền tố có btn. – skamradt

+2

Các liên kết trong câu trả lời không hoạt động nữa, nhưng tôi nghĩ rằng đây là bài viết bạn có nghĩa là: http://jcl.delphi-jedi.org/documents/styleguide.html, với điều này như là một tài nguyên bổ sung tốt http://jvcl.delphi-jedi.org/StyleGuide.htm –

1

JVCL-dài CodeGear của “Object Pascal Style Guide”

(điều này có vẻ giống như các phiên bản JCL, đối với tôi.)

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

(Cảm ơn đến Jeroen Pluimers, để cung cấp các liên kết mới.)

2

Econos - (. Phụ đề “Delphi 4 cho nhà phát triển của tài liệu Hướng dẫn tiêu chuẩn mã hóa”) Mã hóa Chuẩn Document

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

+0

Ah, các bậc thầy cũ tốt Xavier Pacheco, Steve Teixeira và Stefan Hoffmeister! Tôi theo dõi hai người đầu tiên, nhưng tự hỏi chuyện gì đã xảy ra với Stefan. –

0

Nó thực sự không quan trọng miễn là bạn chọn một trong và dính vào nó.Một tiêu chuẩn mã hóa giống như một phương ngữ, và miễn là tất cả mọi người trong nhóm nói cùng một phương ngữ, bạn vẫn ổn.

Điều đó nói rằng, tại sao không chọn cùng một tiêu chuẩn như thư viện thời gian chạy (VCL) và việc sử dụng tài liệu của bạn? Sau đó, tất cả các bạn sẽ nói cùng một phương ngữ và bạn sẽ có một thời gian dễ dàng hơn khi đọc mã thư viện thời gian chạy. Và có rất nhiều ví dụ mã để minh họa các quy ước mã hóa.

+0

Đó là một điểm rất hay và tôi đánh giá cao việc bạn đã đạt được điều đó. Cảm ơn! Điều đó nói rằng, chúng tôi muốn chọn một tiêu chuẩn có xu hướng về phía "hoàn chỉnh", vì vậy tài liệu VCL có thể không phải là tốt nhất. –

+0

Sự thuyết phục cá nhân của tôi là ít hơn, và vào cuối ngày, các quy tắc bạn có thể nắm bắt trong một tài liệu tiêu chuẩn ít quan trọng đối với khả năng bảo trì hơn là thái độ và kinh nghiệm của lập trình viên. – Jozz

0

Có thể có khuynh hướng đưa ra các tiêu chuẩn mã hóa kỹ thuật quá mức đến mức chúng có được cách viết mã.

Tôi đồng ý với nhận xét của Jozz. Bạn có thể xem xét tất cả các tiêu chuẩn được đề nghị, chọn một và ép buộc nó trên các lập trình viên của bạn hoặc bạn có thể giúp nhóm của bạn tham gia vào quá trình này.

Theo kinh nghiệm của tôi, cách tốt nhất để có được một đội ngũ tham gia là có đội ngũ đưa ra ý tưởng và lợi ích của việc áp dụng. Tài năng hiện tại của bạn là tài nguyên tốt nhất của bạn. Tương tự như vậy, họ có thể là kẻ thù cuối cùng của bạn nếu bạn ép họ xuống một con đường mà họ không mua vào.

Vì vậy, hãy nhìn vào các biến thể mã hóa hiện tại của bạn và nhận được nhóm với nhau cho một số cuộc thảo luận sôi nổi về:

  • Những lý do cho việc áp dụng một tiêu chuẩn mã hóa.
  • Cân nhắc cần thiết trong tiêu chuẩn hóa.
  • Làm nổi bật bất kỳ sự bất an nào trong nhóm xung quanh vấn đề này.
  • Tìm điểm thỏa thuận. Điều gì quan trọng và những gì không.
  • Thiết lập một số mục tiêu công ty để mọi người cảm thấy như họ đang làm việc hướng tới mục tiêu chung.
  • Yêu cầu nhóm bán lợi ích của việc chuẩn hóa cho chính họ.

Mục tiêu quan trọng nhất phải là thiết lập ‘chuẩn’ phục vụ tốt nhất cho nhóm của bạn và công ty bạn.

0

Vì một số lý do lịch sử không hoạt động, tiêu chuẩn mã hóa trong công việc của tôi là có tất cả các từ khóa bằng chữ hoa, trong cả hai delphi và sql. Cảm ơn chúa vì khóa mũ.