Có kỹ thuật hay kiểm tra tốt cho các loại đặt tên?

Một câu hỏi khó xử, cởi mở, nhưng đó là một vấn đề tôi luôn luôn chống lại:

Phần mềm dễ bảo trì và hoạt động với phần mềm được thiết kế tốt. Cố gắng tạo ra một thiết kế trực quan có nghĩa là đặt tên cho các thành phần của bạn theo cách mà nhà phát triển tiếp theo có thể suy ra chức năng của thành phần đó. Đây là lý do tại sao chúng tôi không đặt tên cho các lớp của mình là "Type1", "Type2", v.v.

Khi bạn mô hình hóa một khái niệm trong thế giới thực (ví dụ như khách hàng), điều này thường đơn giản như đặt tên kiểu của bạn sau khi khái niệm thế giới thực được mô hình hóa. Nhưng khi bạn đang xây dựng những thứ trừu tượng, theo định hướng hệ thống hơn, thì rất dễ để hết những cái tên vừa dễ đọc vừa dễ tiêu hóa.

Nó trở nên tồi tệ hơn (đối với tôi) khi cố gắng đặt tên cho các họ loại, với kiểu cơ sở hoặc giao diện mô tả những gì các thành phần phải làm, nhưng không phải là cách chúng hoạt động. Điều này tự nhiên dẫn đến mỗi loại dẫn xuất cố gắng mô tả hương vị của việc triển khai (ví dụ IDataConnectionvà SqlConnectiontrong .NET Framework), nhưng làm thế nào để bạn thể hiện một cái gì đó phức tạp như "hoạt động bằng cách phản chiếu và tìm kiếm một bộ thuộc tính cụ thể"?

Sau đó, khi cuối cùng bạn đã chọn một tên cho loại mà bạn nghĩ mô tả những gì nó đang cố gắng thực hiện, đồng nghiệp của bạn hỏi "WTF điều này DomainSecurityMetadataProviderthực sự làm gì? "

Có bất kỳ kỹ thuật tốt nào để chọn một tên có ý nghĩa tốt cho một thành phần, hoặc làm thế nào để xây dựng một họ các thành phần mà không bị nhầm lẫn tên?

Có bất kỳ thử nghiệm đơn giản nào mà tôi có thể áp dụng cho một tên để có cảm giác tốt hơn về việc liệu tên đó có "tốt" hay không và có trực quan hơn với người khác không?

Để đặt tên, có sáu kỹ thuật đã được chứng minh là có hiệu quả đối với tôi:

1. dành nhiều thời gian cho việc phát minh ra tên
2. sử dụng mã đánh giá
3. đừng ngần ngại đổi tên
4. dành nhiều thời gian cho việc phát minh ra tên
5. sử dụng mã đánh giá
6. đừng ngần ngại đổi tên

Tái bút Trong trường hợp nếu API của bạn sẽ được công khai, thì ở trên sẽ áp dụng trước đó - bởi vì, bạn biết đấy,

"API công khai, giống như kim cương, là mãi mãi. Bạn có một cơ hội để làm cho đúng, vì vậy hãy cố gắng hết sức ..." (Joshua Bloch, Cách thiết kế API tốt và tại sao lại có vấn đề )

Kiểm tra cơ sở của tôi là nếu bạn có thể mô tả chức năng của biến bằng cách chỉ sử dụng các từ từ biến:

ví dụ: nếu DomainSecurityMetadataProvider hoặc "Cung cấp siêu dữ liệu bảo mật tên miền" hoặc "Cung cấp siêu dữ liệu liên quan đến bảo mật tên miền", thì tốt.

Tuy nhiên, có những sắc thái khác nhau từ người này sang người khác:

ví dụ: đối với tôi, original_team_code là mã cho nhóm ban đầu, trong khi đối với người khác, nó có thể là mã gốc cho nhóm. Một trong những mục yêu thích cá nhân của tôi là "UnsafeLegacyMutex", mà tôi không thể không đọc là "Đây là một Mutex di sản không an toàn", thay vì "Đây là một Mutex cho Mã di sản của ThreadUnsafe".

Vì vậy, bài kiểm tra mở rộng của tôi là viết biến xuống bảng / wiki / trò chuyện và để mọi người đoán nghĩa của nó.

Có bất kỳ kỹ thuật tốt nào để chọn một tên có ý nghĩa tốt cho một thành phần, hoặc làm thế nào để xây dựng một họ các thành phần mà không bị nhầm lẫn tên?

Không hẳn vậy.

Tuy nhiên, một mẹo là tránh "giọng nói thụ động".

"DomainSecurityMetadataProvider" là thụ động. Không có động từ, tất cả các danh từ và danh từ được sử dụng làm tính từ.

"ProvMetadataForDomainSecurity" hoạt động nhiều hơn. Có một động từ.

Lập trình hướng đối tượng là tất cả (thực sự) danh từ-động từ. Danh từ == đối tượng. Động từ == phương thức. Vì vậy, một tên lớp thường rất "danh từ". Để bỏ thói quen này, và bắt đầu chèn động từ, thật khó.

Có bất kỳ thử nghiệm đơn giản nào mà tôi có thể áp dụng cho một tên để có cảm giác tốt hơn về việc liệu tên đó có "tốt" hay không và có trực quan hơn với người khác không?

Vâng. Bạn đã xác định một bài kiểm tra xuất sắc trong câu hỏi của bạn. Hỏi người khác.

Vào thời xa xưa, chúng tôi gọi đây là "hướng dẫn thiết kế". Đó là một thỏa thuận lớn, đầy mồ hôi trong một phương pháp thác nước. Ngày nay, với các phương thức Agile, nó sẽ là sự hợp tác thông thường giữa tác giả và người dùng của một lớp. Nó không (và không nên) mất nhiều thời gian. Thảo luận về thiết kế (và tên) trước khi viết các bài kiểm tra (và mã) sẽ làm giảm yếu tố gây ngạc nhiên và có thể ngăn chặn WTF.

Sử dụng từ điển đồng nghĩa

Rất thường xuyên, tôi sẽ đề cập đến một từ điển đồng nghĩa khi thực hiện phát triển mới để tìm các từ thích hợp để mô tả các lớp và phương thức của tôi.

Các lớp chủ yếu chứa logic hoạt động

Tôi có xu hướng đặt tên các lớp chủ yếu cung cấp các phương thức hoạt động trong cấu trúc danh từ-động từ như "EntityProvider", "EntityLocator", v.v.

Các lớp này thường không chứa nhiều trạng thái.

Các lớp có trạng thái

Màn hình UI và các thực thể dữ liệu nói chung là trạng thái, và vì vậy tôi chỉ cần đặt tên cho các lớp này bằng một mẫu danh từ hoặc tính từ-danh từ.

Ví dụ: Người, Nhân viên, Hiện tạiEmployee, CựuEmployee

Các lớp tiện ích

Các lớp chỉ chứa các phương thức tĩnh thường được coi là các lớp "tiện ích", vì vậy tôi luôn đặt tên chúng với hậu tố "Tiện ích".

Ví dụ: NetworkUtilities, FileUtilities

Xét nghiệm

Tôi không có bất kỳ bài kiểm tra tốt nào để quyết định xem có thứ gì đó được đặt tên kém hay không, nhưng tôi khuyên bạn nên thử sử dụng một danh từ riêng và / hoặc một động từ trong tên, sau đó suy nghĩ xem danh từ / động từ đó có mô tả chính xác những gì bạn ' đặt tên lại.

Nếu bạn cảm thấy rằng có nhiều hơn lớp / phương thức không được bắt bởi tên, thì lớp / phương thức đó có thể cần phải được cấu trúc lại.

Alan Green và Jeff Attwood đã viết về tệ nạn của các lớp đặt tên với hậu tố "Manager". Họ cho rằng thuật ngữ "Người quản lý" bị lạm dụng và quá mơ hồ để truyền đạt bất cứ điều gì có ý nghĩa. Tôi phải đồng ý.

Bài viết của Jeff cũng cung cấp một danh sách các hướng dẫn được đề xuất từ ​​Hoàn thành mã của Steve McConnell.

biến

Gần đây, tôi đã thử nghiệm các tên tham số / biến mô tả dài hơn kết hợp các giới từ, chẳng hạn như "Of", "By", "For", v.v. Một số ví dụ được hiển thị bên dưới:

string firstNameOfEmployee;

string lastNameOfEmployee;

// here I nimbly avoid worrying about whether to call it "Id" or "ID" :)
int idOfEmployee;

decimal amountForDeposit;

Account accountForDeposit;

Tôi thấy rằng điều này hoạt động tốt với tính năng intellisense của Visual Studio giúp dễ dàng nhập các tên dài này. Tôi cũng thấy rằng có ít sự trùng lặp của các tiền tố tên biến (ví dụ: personID, personFirstName, personLastName so với idOfPerson, FirstNameOfPerson, lastNameOfPerson), cung cấp một "hàm băm" tốt hơn giúp cho intellisense trở nên hữu ích hơn.

Sau đó, khi cuối cùng bạn đã chọn một tên cho loại mà bạn nghĩ mô tả những gì nó đang cố gắng thực hiện, đồng nghiệp của bạn hỏi "WTF có thực sự DomainSecurityMetadataProvider này không?"

Loại tên nào bạn mong đợi cho một lớp cụ thể và miền cụ thể? Điều này tốt như bạn sẽ nhận được mà không đặt tên lớp của bạn thành một câu (điều này sẽ khiến mọi người nghĩ rằng bạn đã giao quá nhiều trách nhiệm cho một lớp học)

Tôi sẽ xem xét bỏ nhà cung cấp từ tên. Nếu nó đặc biệt đề cập đến Siêu dữ liệu, mọi người đều biết bạn đang sử dụng sự phản chiếu. Bạn có thể làm cho nó một từ ngắn gọn hơn (hoặc có thể thay đổi thành một từ khác - đó là một người tiêu dùng nhiều hơn là một nhà cung cấp từ những gì bạn đã viết)

Sử dụng phép ẩn dụ để mô tả các bộ phận của hệ thống. Không chỉ nó sẽ làm cho bạn khám phá các tương tự mới, nó sẽ giúp đặt tên dễ dàng hơn.

(Tôi biết đây không phải là một ví dụ mạnh nhưng dù sao đi nữa) Ví dụ: bạn có thể gọi một biến hoặc một kiểu như mailbox, đóng vai trò là một hàng đợi cho các tin nhắn nhận được cho một lớp.

Một điều tôi rất chắc chắn là Tên KHÔNG BAO GIỜ được phép không chính xác. Ví dụ tốt nhất, trong một số bao thanh toán lại, rất nhiều mã đã thay đổi và một vài biến bắt đầu đề cập đến một cái gì đó khác với những gì tên của chúng gợi ý.

Ngay sau đó, một lập trình viên đã dành nhiều thời gian và sử dụng một số cuộc gọi cơ sở dữ liệu rất tốn kém để cố gắng nắm giữ một số dữ liệu nhất định đã được trích xuất và lưu trữ. Tôi đã đổi tên tất cả mọi thứ và đột nhiên chúng tôi có thể loại bỏ một tấn logic quá phức tạp và lỗi.

Hy vọng những trường hợp mà bạn phải suy nghĩ rất nhiều về những cái tên là rất hiếm. Khi những trường hợp đó phát sinh, chỉ cần viết một đoạn văn giải thích những gì lớp làm. Trái với nhận xét trong chức năng hoặc nhận xét cấp chức năng, mục đích chính của một lớp hiếm khi thay đổi nên nguy cơ nhận xét bị lỗi thời là tương đối nhỏ. Vì vậy, bạn có thể viết một vài đoạn hoặc thậm chí vẽ ASCII để giải thích những gì lớp học làm.