Trong một chương trình không nhỏ, khi bạn không có nhiều mục đích, để duy trì khả năng đọc mã, các thuật ngữ phổ biến và cải thiện sự hiểu biết lẫn nhau giữa các thành viên nhóm, phải xác định và duy trì từ vựng chương trình .Làm thế nào để bạn duy trì vốn từ vựng của chương trình?
Làm thế nào để bạn (hoặc công ty của bạn) đối phó với nhiệm vụ này, bạn có kỷ luật gì, bạn sẽ giới thiệu những sắp xếp nào?
Hầu hết các dự án có kích thước hợp lý phải có tài liệu chuẩn lập trình/mã hóa quy định các quy ước chung và hướng dẫn đặt tên cần được tuân theo.
Một cách khác để trợ giúp vấn đề này là thông qua đánh giá mã. Rõ ràng một số sự phối hợp giữa các nhà tổng quan là cần thiết (tài liệu cũng giúp điều đó). Các đánh giá mã giúp giữ cho các nhà phát triển xanh và các nhà phát triển cao cấp giống nhau trên đường đua và hành động như một cách để thực thi các tiêu chuẩn mã hóa.
Chia gói/mô-đun của bạn thành các nhóm hợp lý và sử dụng các tên mô tả và súc tích. Tránh các tên chung trừ khi chúng thực sự là quầy vv Tạo các quy ước cho các nhóm chức năng hoặc chức năng và gắn bó với chúng.
Sau khi tôi tạo các quy ước, tôi sẽ duy trì chúng như thế nào? –
Tôi muốn nói kỷ luật –
Thiết bị điều khiển tên miền thú vị ở đây, vì nó khuyến khích các lập trình viên nắm lấy từ vựng của miền. Ngoài ra, có một số quy ước thiết kế, cho phép bạn tham khảo các phần ứng dụng của bạn bằng các thuật ngữ nổi tiếng, như dịch vụ, kho, nhà máy, v.v.
Kết hợp từ vựng miền và sử dụng quy ước kỹ thuật ở trên có thể là giải pháp tốt.
Nhóm của tôi giữ loại thông tin này (quy ước/từ vựng, v.v.) trên wiki. Điều này giúp dễ dàng cập nhật và chia sẻ.
Tôi tự hỏi làm thế nào để bạn giữ nó cập nhật? Bạn có bất kỳ quy tắc nào về "khi bạn thay đổi IFooElement thành IFooEntity không, hãy cập nhật wiki trên các trang a, b và c?" –
Điều này có thể có vấn đề nếu mọi người lười biếng. Các trang hữu ích được cập nhật khi mọi người sử dụng thường xuyên và nếu bạn tìm thấy một vấn đề/sai lầm thì bạn phải sửa chữa nó. Các trang ít hữu ích hơn nên được xóa hoặc hợp nhất thành một thứ hữu ích có thể được duy trì dễ dàng hơn. – Chris
@Ilya Ryzhenkov,
Tôi sợ nhất công ty không có thực hành như vậy :) Tôi đã làm việc trong công ty không quá nhỏ với cơ sở mã nhiều triệu LỘC và họ không có bất kỳ tài liệu hướng dẫn chung (bên cạnh hướng dẫn mã hóa thông thường)
Trên một trong các dự án của mình, chúng tôi duy trì từ đồng nghĩa các thuật ngữ phổ biến được sử dụng trong miền ứng dụng của chúng tôi và sử dụng nó trong quá trình xem xét mã. Tôi đã phân tích tài liệu .NET XML khác nhau theo thời gian để quyết định các đối tượng nào nên được thêm vào từ điển. Chỉ có nghĩa là để thực thi sự tuân thủ với từ điển đồng nghĩa là hướng dẫn mã hóa.
cách tiếp cận Wiki được chứng minh là không áp dụng vì không ai quan tâm để cập nhật nó thường xuyên :)
Tôi đang tự hỏi những gì phương pháp nào bạn sử dụng tại JetBrains? Tôi đã kiểm tra mã ReSharper trong Reflector và đã ngạc nhiên với số lượng và tên của các thực thể :)
Câu hỏi là "HOw" không "GÌ" –
Có lẽ làm rõ trong câu hỏi, sau đó? Bạn hỏi làm thế nào, và Michael nói với một tài liệu tiêu chuẩn. –
William, vì vậy bạn nghĩ rằng chỉ cần có một tài liệu "chuẩn" sẽ làm cho từ vựng chương trình có thể duy trì được? –