Làm thế nào để đặt tên một cái gì đó khi tùy chọn hợp lý là một từ khóa dành riêng? [đóng cửa]

Đôi khi, tên hợp lý nhất cho một cái gì đó (ví dụ: một biến) là một từ khóa dành riêng trong ngôn ngữ hoặc môi trường lựa chọn. Khi không có từ đồng nghĩa thích hợp như nhau, làm thế nào để đặt tên cho nó?

Tôi tưởng tượng có những heuristic thực hành tốt nhất cho vấn đề này. Chúng có thể được cung cấp bởi những người sáng tạo hoặc thống đốc của ngôn ngữ lập trình và môi trường. Ví dụ: nếu python.org (hoặc Guido van Rossum) nói cách đối phó với nó trong Python, đó sẽ là một hướng dẫn tốt trong cuốn sách của tôi. Một liên kết MSDN về cách đối phó với nó trong C # cũng sẽ tốt.
Ngoài ra, các hướng dẫn được cung cấp bởi những người có ảnh hưởng lớn trong công nghệ phần mềm cũng có giá trị. Có lẽ Google / Bảng chữ cái có một hướng dẫn phong cách tốt đẹp dạy chúng ta cách đối phó với nó?

Đây chỉ là một ví dụ: trong ngôn ngữ C #, "mặc định" là một từ khóa dành riêng. Khi tôi sử dụng một enum, tôi có thể muốn đặt tên cho giá trị mặc định là "default" (tương tự như các câu lệnh "switch"), nhưng không thể.
(C # là trường hợp nhạy cảm, và hằng enum nên được vốn, vì vậy "mặc định" là sự lựa chọn rõ ràng ở đây, nhưng chúng ta hãy giả định hướng phong cách hiện tại của chúng tôi ra lệnh tất cả các hằng số enum là trở thành chữ thường.)
Chúng ta có thể xem xét các từ "defaultus ", Nhưng điều này không tuân thủ Nguyên tắc tối thiểu ngạc nhiên . Chúng ta cũng nên xem xét "tiêu chuẩn" và "ban đầu", nhưng thật không may "mặc định" là từ truyền đạt chính xác mục đích của nó trong tình huống này.

Đối với một tùy chọn enum, bạn nên sử dụng trường hợp tiêu đề như thế nào Default. Vì C # phân biệt chữ hoa chữ thường nên nó sẽ không va chạm với từ khóa dành riêng. Xem hướng dẫn đặt tên .net .

Vì tất cả các thành viên công khai phải là trường hợp tiêu đề trong .net và tất cả các tên dành riêng là chữ thường, bạn không nên thực sự gặp phải điều này ngoại trừ các biến cục bộ (bao gồm các tham số). Và người dân địa phương thường có danh từ hoặc cụm từ làm tên, vì vậy, rất hiếm khi tên tự nhiên nhất sẽ va chạm với một từ khóa. Ví dụ. defaultValuethường sẽ là một tên tự nhiên hơn default. Vì vậy, trong thực tế đây không phải là một vấn đề lớn.

Trong C #, bạn có thể sử dụng @tiền tố "" để thoát các từ khóa dành riêng để chúng có thể được sử dụng làm định danh (như @default). Nhưng điều này chỉ nên được sử dụng nếu bạn thực sự không có lựa chọn nào khác, tức là nếu bạn đang can thiệp vào thư viện của bên thứ ba sử dụng từ khóa dành riêng làm định danh.

Tất nhiên các ngôn ngữ khác có cú pháp và từ khóa khác nhau và do đó giải pháp khác nhau cho vấn đề này.

SQL có khá nhiều từ khóa, nhưng nó rất phổ biến để thoát khỏi các định danh, như thế [Table]. Một số thậm chí làm như vậy cho tất cả các định danh, bất kể họ có đụng độ với một từ khóa hay không. (Rốt cuộc, một từ khóa xung đột có thể được giới thiệu trong tương lai!)

Powershell (và một loạt các ngôn ngữ kịch bản lệnh khác) tiền tố tất cả các biến có sigil như $ có nghĩa là chúng sẽ không bao giờ va chạm với từ khóa.

Lisp hoàn toàn không có từ khóa, ít nhất là không phải theo nghĩa thông thường.

Python có một quy ước được công nhận chính thức trong PEP-8 :

Luôn luôn sử dụng cls cho đối số đầu tiên cho các phương thức lớp.

Nếu tên của một đối số hàm đụng độ với một từ khóa dành riêng, thì tốt hơn là nối thêm một dấu gạch dưới duy nhất thay vì sử dụng một từ viết tắt hoặc viết sai chính tả. Do đó class_ tốt hơn clss. (Có lẽ tốt hơn là tránh các cuộc đụng độ như vậy bằng cách sử dụng một từ đồng nghĩa.)

Một số ngôn ngữ như Brainfuck hoặc Whitespace tránh việc xác định các từ, hoàn toàn vượt qua vấn đề.

Nói tóm lại, không có câu trả lời độc lập với ngôn ngữ cho câu hỏi của bạn, vì nó rất phụ thuộc vào cú pháp và quy ước của ngôn ngữ cụ thể.

Tôi sẽ nối thêm dấu gạch dưới (default_)

Ưu điểm:

• đơn giản
• Rõ ràng (tại sao bạn lại thêm dấu gạch dưới?)
• thích hợp
• dễ sử dụng
• hoạt động trong tất cả các ngôn ngữ hiện đại mà tôi biết
• gần nhất với tùy chọn logic

Tại sao tôi không thích các giải pháp khác:

Từ đồng nghĩa:

• khó tìm
• thường không cùng một nghĩa chính xác (sắc thái)

Bổ sung / Chuẩn bị một từ:

• không nhất quán (defaultValue, defaultItem)
• tăng độ dài mà không tăng khả năng đọc

Thay đổi chữ cái (clazz thay vì lớp):

• không nhất quán (clazz, klass, klazz)

Nối một số (default1):

• đặt câu hỏi cho default2

Bổ sung / Chuẩn bị thư:

• không rõ ràng (lập trình viên phải đoán rằng nó đã được sử dụng cho namecollision và không phải là một phím tắt cho cái gì khác)

Thoát khỏi một từ khóa (@default (c #), `default` (scala))

• chỉ có thể trong một số ngôn ngữ
• tính năng hiếm khi được sử dụng, chủ yếu để tương thích với các ngôn ngữ khác
• làm cho việc sử dụng api của bạn trở nên khó khăn hơn (họ phải biết cách thực hiện và nhớ cách thực hiện)

Khi nào tôi không sử dụng nó:

• hiện có, sử dụng rộng rãi các quy ước khác
• Tôi đã biết một từ đồng nghĩa phù hợp
• trong trường hợp enum cụ thể của bạn, tôi sẽ làm theo câu trả lời @JacquesB

"Mặc định" có thể không phải là một giá trị enum hữu ích. Nó đại diện cho một hành vi có thể thay đổi tùy thuộc vào bối cảnh nơi nó được sử dụng.

Điều đó đang được nói, nếu ngôn ngữ của bạn là trường hợp nhạy cảm, sau đó sử dụng một trường hợp khác cho từ này. (Mặc định so với mặc định)

Hoặc tốt hơn nữa, hãy nỗ lực thêm để gõ thêm một vài chữ cái và gọi nó là DefaultValue.

Tôi đặc biệt khuyên bạn KHÔNG nên thay đổi quy ước đặt tên cục bộ (hoặc thêm các ký tự vô nghĩa) cho mục đích định hướng (giống như đã được đề xuất trong các bài đăng khác). Nó tạo ra sự nhầm lẫn nếu ý định không rõ ràng và có thể đặt ra câu hỏi tại sao nó được đặt tên theo cách này. Nó có thể được giải quyết mà không cần nó.

Trong mọi trường hợp, có thể sử dụng một từ có nghĩa đồng nghĩa hoặc làm cho tên cụ thể hơn (hoặc thậm chí dài dòng). Ngay cả khi nó có thể giới thiệu sự lặp lại của bối cảnh, nó có thể là một giải pháp tốt hơn.

Ví dụ: giả sử bạn có một enum Modesẽ hiển thị giá trị mặc định như trong trường hợp của bạn. Đặt tên nó default_modecó vẻ không phải là tốt nhất do sự lặp lại, nhưng nó tránh sự mơ hồ trong khi truyền đạt ý nghĩa mong muốn.

Bạn sẽ cần sử dụng các từ khác nhau hoặc được sửa đổi, điều đó là rõ ràng.
Vì vậy, điều này thường có nghĩa là hoặc

• một từ hoàn toàn khác
• một tiền tố
• một hậu tố

Một yếu tố khác để xác định là làm thế nào để tham gia nhiều từ và các tùy chọn thường là

• allonewordnoseparators
• words_with_underscores-or-dash ( Snake_case )
• Viết hoaForClarityAndReadability ( CamelCase )

Đề nghị của tôi là sử dụng tiền tố hoặc hậu tố và dấu gạch dưới / dấu gạch ngang, vd

local_default, my_default, a_default, domain_specific_default
default_local, default_me, default_a, default_domain_specific

local_defaultcó lợi thế là tất cả các địa phương được căn chỉnh và do đó nổi bật nhanh chóng nhưng nhược điểm mà bạn luôn phải đọc đến phần thứ hai để có được tên duy nhất. default_localcó lợi thế ngược lại là tên biến duy nhất nhanh chóng được nhìn thấy, nhưng người dân địa phương không phải lúc nào cũng dễ dàng được nhóm lại một cách trực quan.

Một vài ví dụ cho cách tiếp cận domain_specific mà tôi đã thấy là: vehicle_modelthay vì modelđó là một từ dành riêng; room_tableđối với bảng SQL tablelà một từ dành riêng.

Hai tùy chọn khác mà tôi đã thấy các ngôn ngữ hoặc tập lệnh sử dụng là:

• dấu ngoặc kép hoặc backtips để bao quanh tên biến và do đó cho phép sử dụng các từ dành riêng. Tương tự như vậy, tôi có thể tưởng tượng một số ngôn ngữ có thể cho phép một ký tự đặc biệt như backspace thoát tên.
• khoảng trắng trong tên biến.

Rõ ràng, làm những gì bạn có thể để tránh tình huống đó. Tôi đã viết phần mềm từ cuối những năm 1970 và những lần tôi thực sự, thực sự phải làm mờ một từ dành riêng là dưới mười, có lẽ gần hơn năm.

Có rất nhiều điều bạn có thể làm, chẳng hạn như nhân đôi chữ cái đầu tiên hoặc cuối cùng ( reservedd) hoặc thêm dấu gạch dưới hàng đầu hoặc dấu ( reserved_). Những gì phù hợp sẽ phụ thuộc rất nhiều vào các quy ước được sử dụng ngôn ngữ bạn đang viết, đặc biệt là liên quan đến dấu gạch dưới hàng đầu hoặc dấu. Ngoài ra, cố gắng không làm những việc với trường hợp có thể bị con người đọc sai (ví dụ: sử dụng Reservedkhi nó khác với reserved).

Khi bạn đã chọn một cái gì đó, hãy đặt nó trong hướng dẫn mã hóa của bạn, đảm bảo mọi người biết về nó và nó được sử dụng một cách nhất quán. Tôi thậm chí còn đi xa hơn để thêm một bình luận nhắc nhở để độc giả không nghĩ đó là một lỗi đánh máy và biết rằng họ sẽ gặp lại nó:

int ccase;  // Name dodges a reserved word

Trong C #, bạn có thể thêm tên của mã định danh bằng @ . Điều này nói cho trình biên dịch coi tên là tên của một định danh và không phải là một từ khóa có thể.

enum @default {Sat, Sun, Mon, Tue, Wed, Thu, Fri};