Cách đặt tên cho biến khi từ vừa là danh từ vừa là động từ

Tôi đã gặp phải một vấn đề góc với hướng dẫn chung về:

• danh từ cho biến
• động từ cho các chức năng

Cụ thể, tôi có một trường hợp từ này mơ hồ - nó có thể là động từ hoặc danh từ. Và trong một số trường hợp khi chúng ta thảo luận về ứng dụng, nó sẽ được sử dụng cả hai cách trong cùng một câu.

Mục đích của tôi là đảm bảo chương trình sẽ vẫn có thể đọc được cho các nhà phát triển trong tương lai cũng như bản thân tôi khi tôi trở lại các phần của mã tháng sau.

Một trong những ví dụ là với a battery. A batterycó một chargevà bạn cũng có thể charge()một pin.

Tôi nghĩ rằng có cả hai Battery.Chargevà Battery.Charge(value)sẽ gây nhầm lẫn cho các nhà phát triển trong tương lai.

Giải pháp hiện tại của tôi là chỉ cần chọn một từ khác cho một hoặc cả hai trường hợp đó (biến và hàm). Vấn đề của tôi với cách tiếp cận đó là Batterybiến và chức năng của đối tượng chargesẽ không phù hợp với các cuộc thảo luận thiết kế liên quan đến Battery.

Câu hỏi của tôi là nếu có một cách khác / tốt hơn để xử lý xung đột này trong quy ước đặt tên?

Một số đọc thêm về chủ đề này. Không ai thực sự giải quyết cụ thể câu hỏi của tôi.

• Hướng dẫn đặt tên phương pháp súc tích có ý nghĩa
• Quy ước đặt tên cho các biến
• Câu trả lời được chọn từ https://softwareengineering.stackexchange.com/questions/14169/what-naming-guferences-do-you-follow

Trong tình huống tương tự tôi cố gắng tìm các từ đồng nghĩa. Trong trường hợp này tôi sẽ sử dụng "nạp tiền" cho động từ. "Re-" là hơi dư thừa, nhưng ý nghĩa là rõ ràng. Sử dụng "sạc" đơn giản cho lần sạc còn lại trong pin là không rõ ràng vì nó không chỉ định bất kỳ đơn vị vật lý nào. Tôi thích "AvailableAmpHours", "hoursUntilRecharg" hoặc một cái gì đó tương tự. Các đơn vị sẽ phụ thuộc vào bất cứ điều gì thuận tiện cho ứng dụng.

Sở thích cá nhân của tôi là chỉ sử dụng động từ cho các chức năng thay đổi trạng thái. Tôi sử dụng danh từ cho các chức năng không đột biến. Tôi cho rằng nó phụ thuộc vào quan điểm của bạn. Ở cấp độ máy, các chức năng không đột biến làm một cái gì đó, nhưng ở cấp độ mô hình, chúng không hoạt động.

Chỉ cần ném nó ra khỏi đó, nhưng có lẽ giải pháp cho trường hợp đặt tên mơ hồ này là loại bỏ hoàn toàn chức năng đó khỏi pin. Tôi chưa bao giờ thấy pin tự sạc và nó sẽ có ý nghĩa hơn đối với tôi khi có lớp BatteryCharger. Điều này sẽ giúp giữ mối quan tâm của bạn tách rời hơn và làm cho hành động rõ ràng hơn.

battery.Charge(50) đấu với batteryCharger.Charge(battery, 50)

Đối với tôi, hình thức thứ hai dễ hiểu hơn nhiều và giữ tất cả mã "Sạc" của bạn ở một nơi thay vì rắc nó trong tất cả các loại pin của bạn.

Tránh nghĩa kép

Bạn đã cố tình chọn một từ có nhiều hơn một nghĩa và quyết định đầu tiên là vấn đề. Có rất nhiều từ gây rắc rối cho các lập trình viên. Một ví dụ khác sẽ là phone. Bạn có thể phoneai đó, hoặc bạn có thể có một phonetrong túi của bạn.

Sử dụng Getters và Setters

Việc đặt tên tiêu chuẩn cho hầu hết các đối tượng là các phương thức getters / settings cho các thuộc tính.

Battery.Charge            // would be a property
Battery.setCharge(value)  // would set the property
Battery.getCharge()       // would get the property

Thuộc tính là trạng thái không phải danh từ

Tôi nghĩ rằng bạn đang nhầm lẫn bằng cách phân loại các thuộc tính đối tượng là danh từ và các biến cũng có thể được nghĩ về các trạng thái. Họ là những quốc gia có liên quan đến phạm vi địa phương của sự tồn tại của họ.

Bạn có thể mô tả giá trị mà họ giữ như một danh từ, nhưng tôi không chắc điều đó đúng trong mọi trường hợp.

Trong thuật ngữ đối tượng OOP mô tả trạng thái của đối tượng đó. Trong trường hợp của bạn Battery, nó là một đối tượng và nó Chargelà một trạng thái. Vì vậy, đó sẽ là một tài sản của đối tượng, nhưng điều này phụ thuộc vào bối cảnh sử dụng nó như thế nào.

Nếu bạn cần có khả năng sử Chargedụng pin, và cũng biết nó Chargelà gì thì bạn có vấn đề.

Sử dụng phạm vi để thực thi bối cảnh

Bối cảnh là những gì sẽ làm rõ nghĩa của một từ bạn dự định một phương pháp hoặc tài sản để truyền đạt. Phạm vi là thiết lập khả năng truy cập của một thuộc tính / phương thức từ bên ngoài đối tượng.

Batter._charge            // a hidden private property
Battery.setCharge(value)  // would set the private property
Battery.getCharge()       // would get the private property
Battery.Charge()          // would perform the Charge action

Phương pháp là động từ

Bạn có thể mô tả phương thức của một đối tượng như một động từ, nhưng hành động từ phù hợp hơn. Trong thuật ngữ OOP, bạn thực hiện các hành động trên các đối tượng bằng các phương thức của chúng. Đó là hình thức xấu để sửa đổi thuộc tính của đối tượng từ bên ngoài đối tượng. Nên gọi một phương thức thực hiện các hành động cần thiết khiến trạng thái của nó thay đổi.

Từ Chargenày là một động từ, nhưng nó cũng là một danh từ. Khi được sử dụng để gọi phương thức của một hành động, nó trở nên rõ ràng rằng động từ đang được sử dụng Battery.Charge(....).

Nhưng, bối cảnh là rất quan trọng. Trong khi từ Charge()này là một động từ thì nó không có ý nghĩa như startCharging().

Phương pháp giá trị Batterycó thể bao gồm Charging, Discharging, setCharge, getCharge, hasCharge, Dischargevà Charged.

Các phương thức một từ đơn giản thường không nêu rõ hành động của chúng một cách rõ ràng, nhưng có một số trường hợp như openvà closeyêu cầu giải thích ít.

Vì vậy, thực sự không có câu trả lời chính xác về cách đặt tên cho các loại thuộc tính / phương thức này. Ngoại trừ việc bạn cần sử dụng các kỹ thuật trên một cách khôn ngoan để đảm bảo không có sự nhầm lẫn.

Chuẩn bị chúng với các động từ sẽ làm cho chúng một động từ hoặc một danh từ.

Battery.doCharge()

Battery.getCharge()

Đối với trường hợp động từ, tôi nghĩ Chargelà OK. Đối với trường hợp danh từ, sẽ getCurrentChargeLevellàm việc cho bạn?

Trong hầu hết các trường hợp, việc thêm một động từ trợ giúp, trạng từ hoặc tính từ là đủ tốt để phân biệt chúng và thực sự có thể giúp hiểu. Với trường hợp Sạc và Sạc () của bạn trên pin, làm cho DeltaCharge () có thể hiển thị rằng đó là chức năng có thể xử lý sạc hoặc xả.

Delta (trong trường hợp có thay đổi nhưng không rõ ràng) là công cụ sửa đổi mà tôi sử dụng và đề xuất cho người khác mọi lúc để xử lý thay đổi trạng thái (ngay cả khi động từ là bán rõ ràng).

Ký hiệu Hungary để giải cứu. Bạn có thể có intChargevà fcnCharge(value), do đó tránh nhầm lẫn và không thêm một tên dài điên rồ khi ba chữ cái sẽ hoạt động tốt.

Hoặc bạn chỉ có thể sử dụng cùng tên và để IDE xử lý nó. Việc tạo một tên dài hơn hoặc khác nhau có thể gây nhầm lẫn trong thời gian dài.