M cđ chun hóa cao vi tính nng này tuy cơng ngh laszlo phát trin mi cho th h web hin đi nh ng đi v i ngi lp trình s làm quen nhanh chóng d a
4. Ghi Chú Thích
- Ghi chú thích cho mã ngu n là gi i thích v đ c t c a mã ngu n đó b ng cách di n đ t thơng d ng nh m m c đích b o trì. Ghi chú thích cho mã ngu n nh m 2 m c đích:
1. Cung c p thông tin t ng quát cho các l nh.
2. Thêm vào các thông tin không th đ c hi u ngay trong mã l nh.
- Chú thích ch ch a thông tin liên quan đ n vi c đ c hi u ch ng trình. Các vi c nh đóng gói kh i ch ng trình hay cài đ t nh th nào thì đ ng mang vào ph n chú thích mã mà c n tách ra tài li u riêng.
- Tránh ghi chú thích các câu lnh đ c vào là hi u ngay, đây là m t s c n tr ng thái quá.
- Chú ý r ng n u ta ghi chú thích b ng mã HTML thì khi truy n v client thì m i ng i dùng đ u có th View Source đ th y.
HU
TE
CH
SV Khóa 2001 – L p Công Ngh Ph n M m
- Chú thích đ c ghi b ng ti ng Anh đúng chính t , v n ph m, ng n g n, đ ngh a, th ng nh t cho m i file và theo các quy t c b d u câu thơng d ng.
Các d ng comment
Chú thích kh i : dùng đ gi i thích cho m t file, ch ng trình con, c u trúc d li u hay gi i thu t.
Chú thích kh i đ c c n dòng ngang c p v i kh i mã đ c chú thích.
Chú thích dịng : ghi ngay trên dịng code cn gi i thích, c n dịng ngang hàng v i câu l nh c n gi i thích.
Chú thích cu i dịng : là chú thích c c ng n gi i thích thêm giá tr hay v trí dịng l nh. Có kho ng cách cách t cu i c a dịng l nh đ xa đ khơng gây nh m l n v i mã th c. Các dịng ghi chú đi các l nh ngang c p nên có chú thích đi c ng ngang c p v i nhau.
// chú thích trong trang .aspx
<!-- this is a block comment -->
//Chú thích trong Codebehide.
...
/*
This is a block comment
Commentator for BlackTurtle algorithm
*/
...
i=145842 // This is a tail comment - a arbitrary value,
doesn't mean much
while (i<k) {
//this is a line comment
intTurtleColor = 2*pi*sqrt(bytTurtleBack)
HU
TE
CH
5. C n Dòng
- Kho ng cách indent m c đ nh là 1 tab (4 ký t ).
- dài dịng : khơng q 120 ký t, n u dòng dài h n 120 ký t ta dùng các quy đ nh v ng t ngang dịng c a các ngơn ng cho phép.
- Ng t ngang dòng : khi m t bi u th c dài quá m t dòng, ta ng t theo nguyên t c o Sau m t d u ",".
o Tr c m t tốn h ng.
o C n dịng ngang v i dòng nguyên th y ho c cách vào m t tab. - C n dòng cho các c p câu l nh hay hàm ph i th ng nh t.