Định dạng bình luận tiêu đề

Tôi nhận ra rằng định dạng "nhận xét tiêu đề" khác nhau tùy theo từng lập trình viên, nhưng đâu là một ví dụ về nhận xét tiêu đề "tốt"?

Về định dạng phong cách, tính nhất quán là quan trọng nhất để phấn đấu. Hãy chắc chắn rằng mọi bình luận định nghĩa lớp trông giống như mọi bình luận khác, mọi bình luận phương thức trông giống như mọi bình luận khác, v.v.

Vì vậy, nếu bạn đang sửa đổi mã hiện có , hãy đảm bảo bạn tuân theo kiểu định dạng của chúng. Các ý kiến ​​(và, ở một mức độ nào đó, mã) sẽ trông giống như chỉ một người đã làm việc trên tệp. Nếu bạn đang bắt đầu một dự án mới, hãy chọn một định dạng kiểu và gắn bó với nó.

Những nơi để bắt đầu tìm kiếm:

• Hướng dẫn kiểu Google (C ++, JavaScript, Objective-C và Python)
• Ví dụ bình luận Oracle JavaDoc