Trong một số giao diện tôi đã viết, tôi muốn đặt tên cho các tham số loại chung có nhiều hơn một ký tự để làm cho mã dễ đọc hơn.

Cái gì đó như....

Map<Key,Value>

Thay vì ...

Map<K,V>

Nhưng khi nói đến các phương thức, các tham số kiểu trông giống như các lớp java cũng gây nhầm lẫn.

public void put(Key key, Value value)

Điều này có vẻ như Key và Value là các lớp. Tôi đã tìm thấy hoặc nghĩ về một số ký hiệu, nhưng không có gì giống như một quy ước từ Mặt trời hay một thực tiễn tốt nhất nói chung.

Các lựa chọn thay thế tôi đoán hoặc tìm thấy ...

Map<KEY,VALUE>
Map<TKey,TValue>

Oracle khuyến nghị những điều sau đây trong Hướng dẫn Java> Generics> Các loại chung :

Loại quy ước đặt tên tham số

Theo quy ước, tên tham số loại là chữ cái đơn, chữ hoa. Điều này trái ngược hoàn toàn với biến quy ước đặt tên mà bạn đã biết và với lý do chính đáng: Nếu không có quy ước này, sẽ rất khó để phân biệt sự khác biệt giữa một biến loại và tên lớp hoặc tên giao diện thông thường.

Các tên tham số loại thường được sử dụng là:

• Phần tử điện tử (được sử dụng rộng rãi bởi Khung sưu tập Java)
• K - Chìa khóa
• N - Số
• T - Loại
• V - Giá trị
• S, U, V, v.v. - Loại 2, 3, 4

Bạn sẽ thấy những tên này được sử dụng trong suốt API Java SE và phần còn lại của bài học này.

Tôi sẽ bám vào nó để tránh sự nhầm lẫn giữa các nhà phát triển và các nhà bảo trì có thể.

Nối Type

Một cuộc thảo luận tốt có thể được tìm thấy trong các bình luận trên trang DZone, Quy ước đặt tên cho các loại tham số .

Xem bình luận của Erwin Mueller. Gợi ý của anh ấy làm cho ý nghĩa rõ ràng hoàn hảo với tôi: Nối từType .

Gọi một quả táo là một quả táo, một chiếc xe hơi. Tên trong câu hỏi là tên của một loại dữ liệu, phải không? (Trong OOP , một lớp về cơ bản xác định một kiểu dữ liệu mới.) Vì vậy, hãy gọi nó là Kiểu Loại.

Ví dụ của Mueller, được rút ra từ bài viết gốc của bài viết:

public interface ResourceAccessor < ResourceType , ArgumentType , ResultType > {
    public ResultType run ( ResourceType resource , ArgumentType argument );
}

Nối T

Một câu hỏi trùng lặp cung cấp câu trả lời này của Andy Thomas. Lưu ý đoạn trích từ hướng dẫn về phong cách của Google cho thấy tên loại nhiều ký tự sẽ kết thúc bằng một chữ hoa T.

Lý do tại sao quy ước đặt tên chính thức giới thiệu bằng cách sử dụng một chữ cái như sau:

Nếu không có quy ước này, sẽ rất khó để phân biệt sự khác biệt giữa một biến loại và một tên giao diện hoặc lớp thông thường.

Tôi nghĩ với các IDE hiện đại rằng lý do không còn giá trị như vd. IntelliJ Idea hiển thị các tham số loại chung với màu sắc khác với các lớp thông thường.

Mã với loại chung như được hiển thị trong IntelliJ Idea 2016.1

Do sự khác biệt đó, tôi sử dụng các tên mô tả dài hơn cho các loại chung của mình, với quy ước giống như các loại thông thường. Tôi tránh thêm các tiền tố và hậu tố như T hoặc Type vì tôi coi chúng là tiếng ồn không cần thiết và không còn cần thiết để phân biệt trực quan các loại chung.

Lưu ý: Vì tôi không phải là người dùng Eclipse hoặc Netbeans, tôi không biết liệu họ có cung cấp tính năng similliar hay không.

Có, bạn có thể sử dụng tên nhiều ký tự cho các biến loại, miễn là chúng được phân biệt rõ ràng với tên lớp.

Điều này khác với quy ước được đề xuất bởi Sun với việc giới thiệu thuốc generic vào năm 2004. Tuy nhiên:

• Nhiều hơn một quy ước tồn tại.
• Tên nhiều ký tự phù hợp với các kiểu Java khác, chẳng hạn như kiểu của Google cho Java .
• Các tên dễ đọc là (ngạc nhiên!) Dễ đọc hơn.

Dễ đọc

Trong một số giao diện tôi đã viết tôi muốn đặt tên tham số loại chung với nhiều hơn một ký tự để làm cho mã dễ đọc hơn.

Khả năng đọc là tốt.

Đối chiếu:

    public final class EventProducer<L extends IEventListener<E>,E> 
            implements IEventProducer<L,E> {

đến:

    public final class EventProducer<LISTENER extends IEventListener<EVENT>,EVENT> 
           implements IEventProducer<LISTENER, EVENT> {

hoặc, với quy ước đa ký tự của Google:

    public final class EventProducer<ListenerT extends IEventListener<EventT>,EventT> 
           implements IEventProducer<ListenerT, EventT> {

    public final class EventProducer<ListenerT extends IEventListener<EventT>,EventT> 
           implements IEventProducer<ListenerT, EventT> {

Phong cách Google

Các Google Java Style Guide cho phép cả hai tên đơn thư và đa nhân vật tầm cỡ như tên kết thúc bằng T.

5.2.8 Tên biến

Mỗi biến loại được đặt tên theo một trong hai kiểu:

• Một bức thư vốn duy nhất, tùy theo sau là một số duy nhất (ví dụ như E, T, X, T2)

• Một tên trong biểu mẫu được sử dụng cho các lớp (xem Phần 5.2.2, Tên lớp ), theo sau là chữ in hoa T (ví dụ : RequestT, FooBarT).

Các vấn đề

Nếu không có quy ước này, sẽ rất khó để phân biệt sự khác biệt giữa một biến loại và một tên giao diện hoặc lớp thông thường. - từ các hướng dẫn của Oracle, các loại Nói chung

Tên một ký tự không phải là cách duy nhất để phân biệt các tham số loại với tên lớp, như chúng ta đã thấy ở trên.

Tại sao không chỉ ghi lại ý nghĩa tham số loại trong JavaDoc?

Đúng là các @paramphần tử JavaDoc có thể cung cấp một mô tả dài hơn. Nhưng cũng đúng là JavaDocs không nhất thiết phải nhìn thấy. (Ví dụ: có một hỗ trợ nội dung trong Eclipse hiển thị tên tham số loại.)

Tên tham số loại nhiều ký tự không tuân theo quy ước của Oracle!

Nhiều quy ước ban đầu của Sun được tuân theo gần như phổ biến trong lập trình Java.

Tuy nhiên, quy ước đặc biệt này là không.

Sự lựa chọn tốt nhất trong số các công ước cạnh tranh là một vấn đề quan điểm. Hậu quả của việc chọn một quy ước khác với Oracle trong trường hợp này là không đáng kể. Bạn và nhóm của bạn có thể chọn một quy ước đáp ứng tốt nhất nhu cầu của bạn.

Bạn có thể sử dụng javadoc để ít nhất cung cấp cho người dùng của lớp chung của bạn một manh mối. Tôi vẫn không thích nó (tôi đồng ý với @ chaper29) nhưng các tài liệu trợ giúp.

ví dụ,

/**
 * 
 * @param <R> - row
 * @param <C> - column
 * @param <E> - cell element
 */
public class GenericTable<R, C, E> {

}

Một điều khác mà tôi đã biết là sử dụng IDE của mình để cấu trúc lại một lớp phá vỡ quy ước. Sau đó làm việc với mã và tái cấu trúc trở lại các chữ cái duy nhất. Làm cho nó dễ dàng hơn cho tôi dù sao nếu nhiều tham số loại được sử dụng.