2011-10-21 38 views

Trả lời

0

Bạn có thể tạo gói có tên old/yourpackage và tư vấn sử dụng gói nếu ai đó dựa vào chức năng/giao diện không dùng nữa và sau đó tạo gói cập nhật yourpackage mà không có nội dung cũ.

Không có cách nào để chèn cảnh báo hoặc phương pháp đánh dấu là không được chấp nhận theo cách khác ngoài có thể trong tài liệu.

1

Không có hỗ trợ cho điều này trong trình biên dịch Go (không phải trong 5g/6g/8g cũng không phải trong gccgo).

Theo như tôi biết, hiện tại không có công cụ kiểm tra mã cho việc này.

Cách duy nhất là đặt cảnh báo không dùng nữa trong tài liệu hoặc chỉ cần xóa mã.

+0

Làm cách nào để chèn cảnh báo? Họ luôn luôn có thể đi trong các phương pháp không được chấp nhận? –

0

Bạn cũng có thể in một dòng tới stdout/stderr nói "Phương pháp này không còn được dùng nữa!" mỗi lần một phương pháp không được chấp nhận được gọi. Bạn cũng có thể bao gồm một gợi ý về cách người dùng nên sửa lỗi này.

+1

Vui lòng không bao giờ in bất kỳ thứ gì trực tiếp vào stderr hoặc stdout từ thư viện vì lý do * any *. Và các chú thích không dùng nữa chỉ thuộc về các thư viện, bởi vì nếu không thì chú thích đơn giản có thể xóa mã. –

2

trình biên dịch Go không báo cáo cảnh báo, chỉ các lỗi ngăn chặn biên dịch .

Go FAQ

20

Godoc: documenting Go code nói này về đánh dấu mã như bị phản đối:

Để báo hiệu rằng một định danh không nên dùng, thêm một đoạn để bình luận doc của nó bắt đầu bằng "được tán thành:" theo sau là một số thông tin về việc không dùng nữa.

Có một số golint issue for reporting use of deprecated identifiersgodoc issue để đánh dấu hoặc ẩn số nhận dạng không dùng nữa.

Báo cáo công cụ staticcheck sử dụng số nhận dạng không được dùng nữa (xem SA1019).

+0

Đây là cách làm đúng và cần được đánh dấu là câu trả lời. Bạn có thể thấy nhóm Go sử dụng mẫu này với 'jpeg/Reader' như của Go 1.6: https://golang.org/src/image/jpeg/reader.go?s=2840:2891#L83 Sau đó, các công cụ phân tích chẳng hạn như 'godoc' và' golint' có thể được cập nhật để phát hiện điều này giống như định nghĩa của 'Bug' doc: https://godoc.org/golang.org/x/tools/cmd/godoc (xem phần' ' tùy chọn -notes'). BUGS và TODO thường không hiển thị trong tài liệu, trừ khi bạn vượt qua cờ và tùy chọn đó. – eduncan911

+0

Những ngày này 'staticcheck' tồn tại và sẽ thực hiện kiểm tra này, như' SA1019' –

Các vấn đề liên quan