Tất cả các ngôn ngữ lập trình đều hỗ trợ comment (đoạn bình luận chỉ để hiển thị, cung câp thêm thông tin sẽ bị trình biên dịch bỏ qua) và trong Java cũng vậy.
Comment trong Java là các ghi chú trong code Java bị bỏ qua bởi trình biên dịch và runtime engine.
Chúng được sử dụng để chú thích code để làm rõ thiết kế và mục đích của nó.
Comment trong Java
Bạn hoàn toàn có thể thêm số comment không số lượng giới hạn vào một tệp Java, nhưng có một số ít ” Cách làm tốt nhất ” nên làm theo khi sử dụng những comment .
Nói chung, các comment code là các nhận xét, giải thích mã nguồn, chẳng hạn như mô tả về các class, interfaces, method và fields làm cho chúng dễ đọc hơn chứ không phải là làm rối thêm.
Bạn đang đọc: Comment trong Java
Có một loại comment Java khác là một Javadoc comment.
Các Javadoc comment hơi khác về cú pháp so với các comment thường, chúng sẽ được chương trình javadoc.exe sử dụng để tạo tài liệu HTML Java.
Tóm Tắt
Tại sao nên sử dụng Comment?
Tác hại của việc không comment code Cách làm tốt nhất là tập thói viết comment code vào code Java của bạn để tăng cường năng lực đọc cho chính bạn và những lập trình viên khác cùng team .
> Nếu bạn đang TỰ HỌC JAVA
Không phải lúc nào bạn cũng hiểu ngay khi nhìn vào một đoạn code Java, cho dù bạn có kinh nghiệm.
Vì thế, một vài dòng comment có thể làm giảm đáng kể lượng thời gian cần thiết để cố gắng hiểu đoạn mã sử dụng để làm gì.
Comment có ảnh hưởng đến chương trình chạy không?
Các comment trong code Java chỉ dành cho con người đọc.
Trình biên dịch Java không quan tâm đến chúng và khi biên dịch chương trình, chúng sẽ bị bỏ qua.
Kích thước và tính hiệu quả của chương trình của bạn sẽ không bị ảnh hưởng bởi số lượng comment trong mã nguồn của bạn.
Có nghĩa là dù bạn viết nhiều commemt thì code của bạn cũng chẳng chậm đi hay phình to lên đâu.
Comment thường (Hay còn gọi là Comment triển khai)
Comment tiến hành có hai định dạng khác nhau :
1. Line comment trong Java (Comment 1 dòng)
Để comment 1 dòng, bạn sư dụng ký hiệu ‘ / / ‘ hai dấu gạch chéo về phía trước, theo sau là comment. Ví dụ :
/ / Comment 1 dòng int guessNumber = ( int ) ( Math. random ( ) * 10 ) ;
Khi trình biên dịch thấy 2 dấu gạch chéo về phía trước, nó biết những thứ ở bên phải là comment, thế nên cho dù nó có là code thì cũng bị bỏ qua.
Điều này giúp ích khi bạn đang gỡ lỗi một đoạn code. Chỉ cần thêm một comment từ một dòng mã bạn đang gỡ lỗi và trình biên dịch sẽ không thực thi nó:
/ / int guessNumber = ( int ) ( Math. random ( ) * 10 ) ;
Comment ngắn cuối dòng code để miêu tả nhanh :
int guessNumber = (int) (Math.random() * 10); / / Random từ 1 đến 10
2. Block Comment (Comment nhiều dòng)
Để bắt đầu comment nhiều dòng, bạn cần gõ ‘/ *’. Mọi thứ giữa dấu gạch chéo về phía trước và dấu hoa thị, ngay cả khi nó nằm trên một dòng khác, chúng đều được coi là một comment cho đến khi các ký tự ‘* /’ kết thúc comment. Ví dụ:
/ * Đây
là
một
comment
nhiều dòng
* /
/ * Đây cũng thế * /
Javadoc Comment
Sử dụng Javadoc comment đặc biệt để ghi lại API Java của bạn. Javadoc là một công cụ đi kèm với JDK giúp tạo tài liệu HTML từ các comment trong mã nguồn.
Một bình luận Javadoc trong file
.java
.java
Được khởi đầu theo cú pháp :
/ * *
và kết thúc như thế này :
* /
Mỗi comment trong số này được khởi đầu bằng một dấu :
*
Đặt những comment này trực tiếp bên trên method, class, constructor hoặc bất kể thành phần Java nào khác mà bạn muốn ghi lại. Ví dụ :
/ * *
* Mô tả class bạn định tạo để làm gì
* Đây là dòng diễn đạt khác
* /
public
Xem thêm: PTU là gì
class MyClass {
/ / Code gì đó
}
Javadoc kết hợp các thẻ khác nhau để kiểm soát cách tạo tài liệu doc. Ví dụ:
@ param
Thẻ này xác lập tham số cho một phương pháp :
/ * * Phương thức main
*@ paramargsString [ ]
* /
public static void main(String[] args){
System.out.println(” Hello World ! “);
}
Java documentation của bạn để biết thêm chi tiết.Có nhiều thẻ khác có sẵn trong Javadoc và nó cũng tương hỗ những thẻ HTML để giúp trình diễn tốt hơn. Xemcủa bạn để biết thêm chi tiết cụ thể .
Mẹo sử dụng Comment trong Java
1. Đừng Comment nếu không cần thiết
Bạn không cần phải lý giải từng dòng code. Nếu chúng chạy trôi chảy / hài hòa và hợp lý và không có gì giật mình xảy ra thì bạn không cần comment .
2. Đặt Comment đúng chỗ
Nếu dòng code bạn đang phản hồi bị thụt vào, hãy bảo vệ rằng comment của bạn cũng như thế .
3. Giữ lại comment có liên quan
Một số lập trình viên rất sửa lỗi trong code rất tốt, nhưng vì lý do nào đó họ quên cập nhật các comment.
Nếu một comment nào đó không còn liên quan, bạn có thể chỉnh sửa hoặc loại bỏ nó đi.
4. Đừng comment lồng nhau
Kiểu comment sau đây sẽ dẫn đến lỗi trình biên dịch :
/ * Đây
là
/ * Đây lại là một comment nữa * /
một block comment
*/
Thường thì những IDE / Editor tân tiến sẽ báo lỗi ngay hoặc đổi khác màu khu vực lỗi để thông tin cho bạn biết là bạn đang đặt comment bị sai .
Hãy nhớ Comment code Java đúng!
Như vậy, qua bài viết này, bạn đã biết một số cách comment trong Java và lý do tại sao nên viết comment.
Đối với một chương trình Java cần duy trì và phát triển trong thời gian dài, việc sửa đổi chương trình, tối ưu code sẽ dễ dàng hơn rất nhiều nếu khi lập trình bạn comment đầy đủ.
Quan trọng là, chi phí cho duy trì và phát triển sẽ giảm đi đáng kể!
Comment với cả Quy ước đặt tên trong Java để tạo ra chương trình Java tốt.Lưu ý : Bạn Cần kết hợpvới cảđể tạo ra chương trình Java tốt .
KHÓA HỌC JAVA WEB> Tham khảo : ( Full Stack ) chuẩn doanh nghiệp. Học với kỹ năng và kiến thức, kinh nghiệm tay nghề thực tiễn từ doanh nghiệp outsourcing cho những người mua không dễ chiều như Châu Âu, Bắc Mĩ .
—
HỌC VIỆN ĐÀO TẠO CNTT NIIT – ICT HÀ NỘI
Học Lập trình chất lượng cao ( Since 2002 ). Học thực tiễn + Tuyển dụng ngay !
Đc : Tầng 3, 25T2, N05, Nguyễn Thị Thập, CG cầu giấy, TP. Hà Nội
SĐT : 02435574074 – 0383.180086
E-Mail : [email protected]
Fanpage: https://facebook.com/NIIT.ICT/
Xem thêm: CHIẾN LƯỢC PHÁT TRIỂN SẢN PHẨM LÀ GÌ?
# niit # icthanoi # niithanoi # niiticthanoi # hoclaptrinh # khoahoclaptrinh # hoclaptrinhjava # hoclaptrinhphp # java # php # python
