Nhận xét ra html

Một nhà phát triển web hay lập trình viên chúng ta đều có trình soạn thảo mã yêu thích riêng của mình và một trong những trình soạn thảo yêu thích nhất của mình đó là SublimeText 3. Một trong những lý do khiến các thành viên lập trình được đánh giá cao bởi vì nó hỗ trợ nhiều phím tắt cho phép bạn làm mọi công việc nhanh chóng hơn. Trong bài viết này mình sẽ trình bày các phím tắt hữu ích nhất trong SublimeText 3

Comment code

Comment là một trong những điều bạn phải làm rất nhiều, ví dụ như comment một hàm nào đó đang làm, hoặc để tạm thời loại trừ một dòng mã cho đích sửa lỗi [và chúng ta dành nhiều thời gian để làm điều đó]

SublimeText đủ thông minh để bình luận thích hợp phụ thuộc vào các ngôn ngữ khác nhau. Do đó, CSS sẽ sử dụng /**/ và HTML sẽ sử dụng. Đối chiếu với các ngôn ngữ lập trình chúng ta có 2 loại nhận xét đó là. bình luận 1 dòng // và bình luận nhiều dòng /**/

Nhận xét 1 dòng chúng ta sử dụng phím tắt Ctrl + / [Windows] và cmd + / [Mac]

Bình luận nhiều dòng. chọn dòng cần bình luận và nhấn tổ hợp phím Ctrl + shift + / [Windows] và cmd + alt + / [Mac]

Di chuyển dòng

Di chuyển các dòng mã lên hoặc xuống trong tệp của bạn trở thành một công việc dễ dàng và nhanh chóng hơn bao giờ hết mà không cần phải cắt và dán

Move line up. Nhấp hoặc chọn dòng cần chuyển rồi nhấn tổ hợp phím Shift + Ctrl + Up [Windows] hoặc ctrl + cmd + Up [Mac]

Move line down. Nhấp hoặc chọn dòng cần chuyển rồi nhấn tổ hợp phím Shift + Ctrl + Down [Windows] hoặc ctrl + cmd + Down [Mac]

Đa con trỏ

Đa con trỏ là một trong những tính năng mà tôi yêu thích SublimeText. Một trong những tính năng tuyệt vời mà không phải trình soạn thảo hoặc thậm chí là một IDE cũng không hỗ trợ

Giữ phím Ctrl + nhấn chuột trái [Windows] hoặc cmd + nhấn chuột trái [Mac]

Ẩn/hiện Thanh bên

Đôi khi bạn cần không gian màn hình rộng hơn để làm việc và ẩn thanh bên chắc chắn sẽ là một giải pháp tốt

Chúng ta giữ phím Ctrl và K + B [Windows] hoặc giữ cmd và K + B [Mac]

Nhân đôi một dòng

SublimeText cho phép rất dễ dàng nhân đôi một hoặc nhiều dòng mã. Nếu bạn chỉ muốn sao chép một dòng, chỉ cần đặt con trỏ vào bất kỳ vị trí nào trên dòng đó, hoặc chọn mọi thứ bạn muốn nếu có nhiều dòng và sử dụng các phím tắt

Chúng ta sử dụng phím tắt Ctrl + Shift + D [Windows] hoặc cmd + Shift + D [Mac]

Tìm kiếm

SublimeText có một tính năng tìm kiếm mạnh mẽ cho phép bạn ngay lập tức tìm thấy một tập tin hoặc một cái gì đó như một phương thức hoặc lớp bên trong một tập tin

Chúng ta nhấn tổ hợp phím Ctrl + P sau đó nhập tên tệp / thư mục [Windows] hoặc cmd + P sau đó nhập tên tệp / thư mục [Mac]

Các phím tắt trên được mình sử dụng thường xuyên trong quá trình phát triển của mình. Hy vọng các bạn thấy hữu ích và chia sẻ các phím tắt hữu ích cho SublimeText mà mình cho mọi người biết nhé

Các chương trình Java có thể có hai loại nhận xét. nhận xét thực hiện và nhận xét tài liệu. Nhận xét triển khai là những nhận xét được tìm thấy trong C++, được phân định bằng /*. */, và //. Nhận xét tài liệu [được gọi là "nhận xét tài liệu"] chỉ dành cho Java và được phân tách bằng /**. */. Nhận xét tài liệu có thể được trích xuất thành tệp HTML bằng công cụ javadoc

Nhận xét triển khai có nghĩa là để nhận xét mã hoặc nhận xét về việc triển khai cụ thể. Nhận xét tài liệu nhằm mô tả đặc điểm kỹ thuật của mã, từ góc độ không triển khai. được đọc bởi các nhà phát triển, những người có thể không nhất thiết phải có mã nguồn trong tay

Nhận xét nên được sử dụng để cung cấp tổng quan về mã và cung cấp thông tin bổ sung không có sẵn trong chính mã đó. Nhận xét chỉ nên chứa thông tin liên quan đến việc đọc và hiểu chương trình. Ví dụ: thông tin về cách xây dựng gói tương ứng hoặc gói đó nằm trong thư mục nào không được đưa vào nhận xét

Thảo luận về các quyết định thiết kế không cần thiết hoặc không rõ ràng là phù hợp, nhưng tránh sao chép thông tin có trong [và rõ ràng khỏi] mã. Quá dễ để những bình luận dư thừa trở nên lỗi thời. Nói chung, tránh bất kỳ nhận xét nào có khả năng bị lỗi thời khi mã phát triển

Ghi chú. Tần suất nhận xét đôi khi phản ánh chất lượng mã kém. Khi bạn cảm thấy bắt buộc phải thêm nhận xét, hãy xem xét viết lại mã để làm cho nó rõ ràng hơn

Nhận xét không nên được đặt trong các hộp lớn được vẽ bằng dấu hoa thị hoặc các ký tự khác.
Nhận xét không bao giờ được bao gồm các ký tự đặc biệt như nguồn cấp dữ liệu biểu mẫu và xóa lùi.

5. 1 Định dạng nhận xét triển khai

Các chương trình có thể có bốn kiểu nhận xét triển khai. khối, một dòng, theo dõi và cuối dòng

5. 1. 1 khối bình luận

Nhận xét khối được sử dụng để cung cấp các mô tả về tệp, phương thức, cấu trúc dữ liệu và thuật toán. Nhận xét khối có thể được sử dụng ở đầu mỗi tệp và trước mỗi phương thức. Chúng cũng có thể được sử dụng ở những nơi khác, chẳng hạn như trong các phương thức. Chặn các nhận xét bên trong một hàm hoặc phương thức phải được thụt lề ở cùng mức với mã mà chúng mô tả

Một chú thích khối nên được đặt trước bởi một dòng trống để phân biệt nó với phần còn lại của mã

/*

 * Here is a block comment.
 */
         

      

/*- thụt lề

/*-* Here is a block comment with some very special
* formatting that I want indent[1] to ignore.
*
*    one
*        two
*            three
*/
    

Ghi chú. thụt lề /*- thụt lề

Xem thêm

5. 1. 2 Nhận xét một dòng

Nhận xét ngắn có thể xuất hiện trên một dòng được thụt vào cấp mã theo sau. Nếu một bình luận không thể được viết trong một dòng, nó phải tuân theo định dạng bình luận khối. Nhận xét một dòng phải được đặt trước một dòng trống. Đây là một ví dụ về nhận xét một dòng trong mã Java [xem thêm]

if [condition] {/* Handle the condition. */
...
}

5. 1. 3 bình luận cuối

Các nhận xét rất ngắn có thể xuất hiện trên cùng một dòng với mã mà chúng mô tả, nhưng phải được dịch chuyển đủ xa để tách chúng khỏi các câu lệnh. Nếu có nhiều hơn một nhận xét ngắn xuất hiện trong một đoạn mã, tất cả chúng sẽ được thụt vào trong cùng một cài đặt tab

Đây là một ví dụ về một nhận xét theo sau trong mã Java

if [a == 2] {return TRUE;            /* special case */
} else {
return isPrime[a];      /* works only for odd a */
}

5. 1. 4 Bình Luận Cuối Dòng

Dấu phân cách chú thích // có thể chú thích toàn bộ dòng hoặc chỉ một phần dòng. Nó không nên được sử dụng trên nhiều dòng liên tiếp cho các bình luận văn bản; . Ví dụ về cả ba phong cách sau

if [foo > 1] {// Do a double-flip.
...
}
else {
return false;          // Explain why here.
}
//if [bar > 1] {
//
//    // Do a triple-flip.
//    ...
//}
//else {
//    return false;
//}

5. 2 Nhận xét tài liệu

Ghi chú. Xem ví dụ về các định dạng nhận xét được mô tả tại đây

Để biết thêm chi tiết, hãy xem "Cách viết nhận xét tài liệu cho Javadoc" bao gồm thông tin về các thẻ nhận xét tài liệu [@return, @param, @see].
liên kết

Nhận xét tài liệu mô tả các lớp, giao diện, hàm tạo, phương thức và trường Java. Mỗi nhận xét tài liệu được đặt bên trong dấu phân cách nhận xét

/*-* Here is a block comment with some very special
* formatting that I want indent[1] to ignore.
*
*    one
*        two
*            three
*/
    
2, với một nhận xét cho mỗi lớp, giao diện hoặc thành viên. Nhận xét này sẽ xuất hiện ngay trước khi khai báo

/**

 * The Example class provides ...
 */
public class Example { ...

Lưu ý rằng các lớp và giao diện cấp cao nhất không được thụt vào, trong khi các thành viên của chúng thì. Dòng đầu tiên của nhận xét tài liệu [/**] cho các lớp và giao diện không được thụt vào; . Các thành viên, bao gồm cả các nhà xây dựng, có 4 khoảng trắng cho dòng chú thích tài liệu đầu tiên và 5 khoảng trắng sau đó

Nếu bạn cần cung cấp thông tin về một lớp, giao diện, biến hoặc phương thức không phù hợp với tài liệu, hãy sử dụng nhận xét khối triển khai hoặc nhận xét một dòng ngay sau phần khai báo. Ví dụ: chi tiết về việc triển khai một lớp nên có trong phần nhận xét khối triển khai như vậy sau câu lệnh lớp, chứ không phải trong phần nhận xét tài liệu lớp

Các chú thích tài liệu không nên được định vị bên trong một khối định nghĩa phương thức hoặc hàm tạo, bởi vì Java liên kết các chú thích tài liệu với khai báo đầu tiên sau chú thích

Chủ Đề