Bất cứ ai khác tìm thấy các lớp và phương thức đặt tên là một trong những phần khó nhất trong lập trình? [đóng cửa]

Vì vậy, tôi đang làm việc trên lớp này có nghĩa vụ yêu cầu tài liệu trợ giúp từ nhà cung cấp thông qua dịch vụ web. Tôi cố gắng để đặt tên cho nó DocumentRetriever, VendorDocRequester, DocGetter, nhưng họ chỉ phải âm thanh. Tôi đã kết thúc việc duyệt qua dictionary.com trong nửa giờ cố gắng đưa ra một từ thích hợp.

Bắt đầu lập trình với những tên xấu giống như có một ngày tóc rất tệ vào buổi sáng, phần còn lại của ngày xuống dốc từ đó. Cảm nhận tôi?

Những gì bạn đang làm bây giờ là tốt, và tôi thực sự khuyên bạn nên tuân thủ cú pháp hiện tại của mình, là:

bối cảnh + động từ + làm thế nào

Tôi sử dụng phương thức này để đặt tên cho các hàm / phương thức, các procs được lưu trữ SQL, v.v. Bằng cách giữ theo cú pháp này, nó sẽ giữ cho Intellisense / Code Panes của bạn gọn gàng hơn nhiều. Vì vậy, bạn muốn EmployeeGetByID () EmployeeAdd (), EmployeeDeleteByID (). Khi bạn sử dụng một cú pháp đúng ngữ pháp hơn như GetEmployee (), AddEmployee () bạn sẽ thấy rằng điều này sẽ thực sự lộn xộn nếu bạn có nhiều Gets trong cùng một lớp vì những thứ không liên quan sẽ được nhóm lại với nhau.

Tôi giống như cách đặt tên các tệp có ngày tháng, bạn muốn nói 2009-01-07.log không phải là 1-7-2009.log bởi vì sau khi bạn có một loạt chúng, thứ tự trở nên hoàn toàn vô dụng.

Một bài học tôi đã học được là, nếu bạn không thể tìm thấy tên cho một lớp, thì hầu như luôn có điều gì đó không ổn với lớp đó:

• bạn không cần nó
• nó làm quá nhiều

Một quy ước đặt tên tốt sẽ giảm thiểu số lượng tên có thể bạn có thể sử dụng cho bất kỳ biến, lớp, phương thức hoặc hàm đã cho nào. Nếu chỉ có một tên có thể, bạn sẽ không bao giờ gặp khó khăn khi nhớ nó.

Đối với các hàm và đối với các lớp đơn, tôi nghiên cứu kỹ hàm để xem liệu hàm cơ bản của nó là biến đổi một loại vật này thành một loại vật khác. Tôi đang sử dụng thuật ngữ đó rất lỏng lẻo, nhưng bạn sẽ phát hiện ra rằng một số lượng lớn các hàm mà bạn viết về cơ bản lấy một cái gì đó ở một dạng và tạo ra một cái gì đó ở dạng khác.

Trong trường hợp của bạn, có vẻ như lớp của bạn biến Url thành Tài liệu. Có một chút kỳ lạ khi nghĩ về nó theo cách đó, nhưng hoàn toàn chính xác, và khi bạn bắt đầu tìm kiếm mẫu này, bạn sẽ thấy nó ở khắp mọi nơi.

Khi tôi tìm thấy mẫu này, tôi luôn đặt tên hàm là x Fromy .

Vì hàm của bạn biến Url thành Tài liệu, tôi sẽ đặt tên cho nó

DocumentFromUrl

Mô hình này là đáng chú ý phổ biến. Ví dụ:

atoi -> IntFromString
GetWindowWidth -> WidthInPixelsFromHwnd // or DxFromWnd if you like Hungarian
CreateProcess -> ProcessFromCommandLine

Bạn cũng có thể sử dụng UrlToDocumentnếu bạn thấy thoải mái hơn với đơn hàng đó. Cho dù bạn nói x Fromy hay y Tox có lẽ là vấn đề của hương vị, nhưng tôi thích Fromthứ tự hơn bởi vì cách đó bắt đầu của tên hàm đã cho bạn biết loại nào nó trả về.

Chọn một quy ước và gắn bó với nó. Nếu bạn cẩn thận sử dụng cùng tên với tên lớp trong các hàm x Fromy của mình , việc nhớ tên bạn đã sử dụng sẽ dễ dàng hơn rất nhiều. Tất nhiên, mẫu này không hoạt động cho tất cả mọi thứ, nhưng nó hoạt động khi bạn viết mã có thể được coi là "chức năng".

Đôi khi không có một tên hay cho một lớp hoặc phương thức, nó xảy ra với tất cả chúng ta. Tuy nhiên, thường thì việc không thể đưa ra một cái tên có thể là một gợi ý cho một cái gì đó sai với thiết kế của bạn. Phương pháp của bạn có quá nhiều trách nhiệm? Lớp học của bạn gói gọn một ý tưởng mạch lạc?

Chủ đề 1:

function programming_job(){
    while (i make classes){
         Give each class a name quickly; always fairly long and descriptive.
         Implement and test each class to see what they really are. 
         while (not satisfied){
            Re-visit each class and make small adjustments 
         }
    }
}

Chủ đề 2:

while(true){
      if (any code smells bad){
           rework, rename until at least somewhat better
      }
}

Không có Thread.s ngủ (...) ở bất cứ đâu ở đây.

Tôi dành rất nhiều thời gian cũng như lo lắng về tên của bất cứ thứ gì có thể được đặt tên khi tôi đang lập trình. Tôi muốn nói rằng nó trả hết rất tốt mặc dù. Thỉnh thoảng khi tôi bị kẹt, tôi để nó một lúc và trong giờ giải lao, tôi hỏi một chút nếu ai đó có một gợi ý hay.

Đối với lớp học của bạn, tôi đề nghị VendorHelpDocRequester.

Cuốn sách Code Complete của Steve Mcconnell có một chương hay về cách đặt tên biến / lớp / hàm / ...

Tôi nghĩ rằng đây là một tác dụng phụ.

Đó không phải là cách đặt tên thực sự khó khăn. Điều khó khăn là quá trình đặt tên khiến bạn phải đối mặt với sự thật kinh hoàng rằng bạn không biết bạn đang làm cái quái gì.

Tôi thực sự chỉ nghe thấy trích dẫn này ngày hôm qua, thông qua blog Tín hiệu so với tiếng ồn ở 37Signals, và tôi chắc chắn đồng ý với nó:

"Chỉ có hai điều khó trong Khoa học Máy tính: vô hiệu hóa bộ đệm và đặt tên cho mọi thứ." - Phil Karlton

Thật tốt khi nó khó khăn. Điều đó buộc bạn phải suy nghĩ về vấn đề này và lớp học thực sự phải làm gì. Tên tốt có thể giúp dẫn đến thiết kế tốt.

Đã đồng ý. Tôi muốn giữ tên loại và biến của mình càng mô tả càng tốt mà không quá dài khủng khiếp, nhưng đôi khi chỉ có một khái niệm nhất định mà bạn không thể tìm thấy một từ hay.

Trong trường hợp đó, nó luôn giúp tôi hỏi đồng nghiệp về đầu vào - ngay cả khi cuối cùng họ không giúp đỡ, điều đó thường giúp tôi ít nhất giải thích thành tiếng và khiến bánh xe quay.

Tôi vừa mới viết về các quy ước đặt tên vào tháng trước: http://caseysoftware.com/blog/usiously-naming-conventions

Ý chính của nó:

verbAdjectiveNounStr struct - với Cấu trúc và Tính từ làm phần tùy chọn

Đối với động từ , tôi dính vào các động từ hành động: lưu, xóa, thông báo, cập nhật hoặc tạo. Thỉnh thoảng, tôi sử dụng "quy trình" nhưng chỉ để đề cập cụ thể đến hàng đợi hoặc công việc tồn đọng.

Đối với danh từ , tôi sử dụng lớp hoặc đối tượng được tương tác. Trong web2project, đây thường là Nhiệm vụ hoặc Dự án. Nếu Javascript tương tác với trang, nó có thể là thân hoặc bảng. Vấn đề là mã mô tả rõ ràng đối tượng mà nó tương tác.

Các cấu trúc là không bắt buộc vì nó là duy nhất với tình hình. Một màn hình danh sách có thể yêu cầu Danh sách hoặc Mảng. Một trong những hàm cốt lõi được sử dụng trong Danh sách dự án cho web2project chỉ đơn giản là getProjectList. Nó không sửa đổi dữ liệu cơ bản, chỉ đại diện cho dữ liệu.

Các tính từ là một cái gì đó hoàn toàn khác. Chúng được sử dụng như là bổ nghĩa cho danh từ. Một cái gì đó đơn giản như getOpenProjects có thể được thực hiện dễ dàng với getProjects và tham số chuyển đổi, nhưng điều này có xu hướng tạo ra các phương thức đòi hỏi khá nhiều hiểu biết về dữ liệu cơ bản và / hoặc cấu trúc của đối tượng ... không nhất thiết phải là thứ bạn muốn khuyến khích. Bằng cách có nhiều chức năng rõ ràng và cụ thể hơn, bạn hoàn toàn có thể bao bọc và ẩn việc triển khai khỏi mã bằng cách sử dụng nó. Đó không phải là một trong những điểm của OO sao?

Không chỉ là đặt tên cho một lớp, việc tạo ra một cấu trúc gói phù hợp có thể là một thách thức khó khăn nhưng bổ ích. Bạn cần xem xét tách các mối quan tâm của các mô-đun của bạn và cách chúng liên quan đến tầm nhìn của ứng dụng.

Hãy xem xét bố cục của ứng dụng của bạn bây giờ:

• Ứng dụng
  • VendorDocRequester (đọc từ dịch vụ web và cung cấp dữ liệu)
  • VendorDocViewer (sử dụng người yêu cầu để cung cấp tài liệu của nhà cung cấp)

Tôi sẽ mạo hiểm đoán rằng có rất nhiều thứ đang diễn ra bên trong một vài lớp. Nếu bạn đã cấu trúc lại điều này thành một cách tiếp cận dựa trên MVC hơn và cho phép các lớp nhỏ xử lý các nhiệm vụ riêng lẻ, bạn có thể kết thúc bằng một cái gì đó như:

• Ứng dụng
  • VendorDocs
    • Mô hình
      • Tài liệu (đối tượng đơn giản chứa dữ liệu)
      • WebServiceConsumer (đối phó với nitty gritty trong dịch vụ web)
    • Bộ điều khiển
      • Cơ sở dữ liệu Chương trình (xử lý kiên trì bằng ORM hoặc phương pháp khác)
      • WebServiceAdOG (sử dụng Người tiêu dùng để lấy Tài liệu và dán vào cơ sở dữ liệu)
    • Lượt xem
      • HelpViewer (sử dụng DBAd CHƯƠNG để nhổ tài liệu)

Sau đó, tên lớp của bạn dựa vào không gian tên để cung cấp ngữ cảnh đầy đủ. Bản thân các lớp có thể liên quan đến ứng dụng mà không cần phải nói rõ ràng như vậy. Kết quả là tên lớp đơn giản và dễ xác định hơn!

Một đề nghị rất quan trọng khác: vui lòng tạo cho mình một bản sao và chọn một bản sao của Mẫu thiết kế đầu tiên. Đó là một cuốn sách tuyệt vời, dễ đọc sẽ giúp bạn tổ chức ứng dụng của bạn và viết mã tốt hơn. Đánh giá cao các mẫu thiết kế sẽ giúp bạn hiểu rằng nhiều vấn đề bạn gặp phải đã được giải quyết và bạn sẽ có thể kết hợp các giải pháp vào mã của mình.

Leo Brodie, trong cuốn sách "Thinking Forth", đã viết rằng nhiệm vụ khó khăn nhất đối với một lập trình viên là đặt tên cho mọi thứ tốt, và anh ta tuyên bố rằng công cụ lập trình quan trọng nhất là từ điển đồng nghĩa.

Hãy thử sử dụng từ điển đồng nghĩa tại http://thesaurus.reference.com/ .

Ngoài ra, không sử dụng Ký hiệu Hungary EVER, tránh viết tắt và nhất quán.

Lời chúc tốt nhất.

Tóm lại:
Tôi đồng ý rằng tên tốt rất quan trọng, nhưng tôi không nghĩ bạn phải tìm ra chúng trước khi thực hiện bằng mọi giá.

Tất nhiên tốt hơn là có một cái tên tốt ngay từ đầu. Nhưng nếu bạn không thể đưa ra một trong 2 phút, đổi tên sau sẽ tốn ít thời gian hơn và là lựa chọn đúng đắn theo quan điểm năng suất.

Long:
Nói chung thường không đáng để suy nghĩ quá lâu về một cái tên trước khi thực hiện. Nếu bạn triển khai lớp của mình, đặt tên là "Foo" hoặc "Dsnfdkgx", trong khi thực hiện, bạn sẽ thấy những gì bạn nên đặt tên cho nó.

Đặc biệt với Java + Eclipse, việc đổi tên mọi thứ không hề khó chút nào, vì nó xử lý cẩn thận tất cả các tham chiếu trong tất cả các lớp, cảnh báo bạn về các xung đột tên, v.v. Và miễn là lớp này chưa có trong kho điều khiển phiên bản, tôi không ' Tôi nghĩ không có gì sai khi đổi tên nó 5 lần.

Về cơ bản, đó là một câu hỏi về cách bạn nghĩ về tái cấu trúc. Cá nhân, tôi thích nó, mặc dù điều đó đôi khi làm phiền đồng đội của tôi, vì họ tin rằng không bao giờ chạm vào một hệ thống đang chạy . Và từ mọi thứ bạn có thể tái cấu trúc, thay đổi tên là một trong những điều vô hại nhất bạn có thể làm.

Tại sao không phải là HelpDocumentServiceClient của một loại miệng hay HelpDocumentClient ... không quan trọng đó là nhà cung cấp, đó là khách hàng của một dịch vụ web liên quan đến các tài liệu trợ giúp.

Và có đặt tên là khó.

Chỉ có một tên hợp lý cho lớp đó:

HelpRequest

Đừng để các chi tiết thực hiện làm bạn mất tập trung vào ý nghĩa.

Đầu tư vào một công cụ tái cấu trúc tốt!

Tôi bám vào những điều cơ bản: VerbNoun (đối số). Ví dụ: GetDoc (docID).

Không cần thiết phải ưa thích. Sẽ dễ hiểu một năm kể từ bây giờ, cho dù đó là bạn hay người khác.

Đối với tôi, tôi không quan tâm bao lâu một tên phương thức hoặc tên lớp dài như mô tả của nó và trong thư viện chính xác. Lâu rồi là những ngày bạn nên nhớ từng phần của API nằm ở đâu.

Intelisense tồn tại cho tất cả các ngôn ngữ chính. Do đó, khi sử dụng API của bên thứ 3, tôi muốn sử dụng intelisense của nó cho tài liệu thay vì sử dụng tài liệu 'thực tế'.

Với ý nghĩ đó, tôi ổn để tạo một tên phương thức như

StevesPostOnMethodNamesByingLongOrShort

Lâu - nhưng vậy thì sao. Ai không sử dụng màn hình 24 inch những ngày này!

Tôi phải đồng ý rằng đặt tên là một nghệ thuật. Sẽ dễ dàng hơn một chút nếu lớp học của bạn đang theo một "mô hình mong muốn" nhất định (nhà máy, v.v.).

Đây là một trong những lý do để có một tiêu chuẩn mã hóa. Có một tiêu chuẩn có xu hướng hỗ trợ đến với tên khi được yêu cầu. Nó giúp giải phóng tâm trí của bạn để sử dụng cho những điều thú vị khác! (-:

Tôi khuyên bạn nên đọc chương liên quan về Hoàn thành mã của Steve McConnell ( liên kết Amazon ), đi sâu vào một số quy tắc để hỗ trợ khả năng đọc và thậm chí bảo trì.

HTH

chúc mừng

Cướp

Không, gỡ lỗi là điều khó khăn nhất đối với tôi! :-)

Trình tải tài liệu? Thật khó để nói mà không có ngữ cảnh.

Nó có thể giúp hành động như một nhà toán học và mượn / phát minh ra một từ vựng cho tên miền của bạn khi bạn đi: giải quyết các từ đơn giản ngắn gợi ý khái niệm mà không cần đánh vần nó mỗi lần. Thông thường tôi thấy cụm từ dài latinate mà có được biến thành từ viết tắt, khiến bạn cần một cuốn từ điển cho các từ viết tắt nào .

Ngôn ngữ bạn sử dụng để mô tả vấn đề, là ngôn ngữ bạn nên sử dụng cho các biến, phương thức, đối tượng, lớp, v.v. Một cách lỏng lẻo, danh từ khớp với các đối tượng và động từ khớp với phương thức. Nếu bạn thiếu từ để mô tả vấn đề, bạn cũng thiếu hiểu biết đầy đủ (đặc điểm kỹ thuật) của vấn đề.

Nếu nó chỉ chọn giữa một tập hợp các tên, thì nó sẽ được điều khiển bởi các quy ước bạn đang sử dụng để xây dựng hệ thống. Nếu bạn đã đến một vị trí mới, được phát hiện bởi các quy ước trước đó, thì bạn nên bỏ ra một số nỗ lực để cố gắng mở rộng chúng (đúng cách, nhất quán) để bao quát trường hợp mới này.

Nếu nghi ngờ, hãy ngủ trên đó và chọn tên rõ ràng nhất đầu tiên vào sáng hôm sau :-)

Nếu bạn thức dậy vào một ngày và nhận ra mình đã sai, thì hãy thay đổi nó ngay lập tức.

Paul.

BTW: Document.fetch () là khá rõ ràng.

Tôi thấy tôi gặp rắc rối nhất trong các biến cục bộ. Ví dụ, tôi muốn tạo một đối tượng kiểu DocGetter. Vì vậy, tôi biết đó là một DocGetter. Tại sao tôi cần phải đặt cho nó một tên khác? Cuối cùng, tôi thường đặt cho nó một cái tên như dg (đối với DocGetter) hoặc temp hoặc một cái gì đó không mô tả.

Đừng quên các mẫu thiết kế (không chỉ các mẫu GoF) là một cách tốt để cung cấp từ vựng thông dụng và tên của chúng nên được sử dụng bất cứ khi nào phù hợp với tình huống. Điều đó thậm chí sẽ giúp những người mới làm quen với danh pháp để nhanh chóng hiểu kiến ​​trúc. Đây có phải là lớp bạn đang làm việc được cho là hoạt động như một Proxy hoặc thậm chí là Mặt tiền không?

Tài liệu của nhà cung cấp không phải là đối tượng? Ý tôi là, cái đó là hữu hình, và không chỉ là một số phép nhân hóa của một phần trong chương trình của bạn. Vì vậy, bạn có thể có một VendorDocumentationlớp với hàm tạo lấy thông tin. Tôi nghĩ rằng nếu một tên lớp có chứa một động từ, thường thì có gì đó không ổn.

Tôi chắc chắn cảm thấy bạn. Và tôi cảm thấy nỗi đau của bạn. Mỗi tên tôi nghĩ chỉ là rác rưởi đối với tôi. Tất cả dường như quá chung chung và tôi muốn học cách pha chút tinh tế và sáng tạo vào tên của mình, khiến chúng thực sự phản ánh những gì chúng mô tả.

Một gợi ý tôi có là tham khảo ý kiến ​​từ điển đồng nghĩa. Word có một điểm tốt, cũng như Mac OS X. Điều đó thực sự có thể giúp tôi thoát khỏi những đám mây và cho tôi một khởi đầu tốt cũng như một chút cảm hứng.

Nếu cái tên sẽ tự giải thích cho một lập trình viên thì có lẽ không cần phải thay đổi nó.