Nhận xét Coding Convention Là Gì – Chuẩn Coding Convention Trong Php Với Psr

Review Coding Convention Là Gì – Chuẩn Coding Convention Trong Php Với Psr là chủ đề trong content hiện tại của Kí tự đặc biệt Pigbang.com. Đọc content để biết đầy đủ nhé.

Codingconventionlà thuậtngữ mà có lẽ bất kì một lập trình viên nào cũng từng nghe nóitới. Dù trên thực tế, việc có tuân thủ theo coding convention hay không hầu như không ảnh hưởng đếnkết quả công việc. Hàm vẫn chạy, code vẫn thực thi đúng, và sảnphẩm sẽ chẳng có gì khác biệt.
Tuy nhiên, với các hệ thốnglớn, được thiết kế và bảo trì qua nhiều giai đoạn, với nguồn nhânlực khác nhau, thì việc tuân theo một coding convention thực sự là vấn đề sống còn. Ngườiđọc code chắc chắn sẽ hạnh phúc và tiết kiệm thời gian hơn rấtnhiều, khi đọc một đoạn code với các biến được đặt tên rõ ràngnhư userName, job, … thay vì a, b, c.
Trong phần này sẽ giúp chúng ta hiểuđược các điều phải tuân thủ khi lập trình, để tạo sự thống nhất giữacác nhóm khi làm việc với nhau, cũng như tạo điều kiện thuận lợi cho ngườiđi sau trong việc bảo trì, phát triển hệ thống.
Mọi định danh (tên biến, hằng, phương thức, lớp, đối tượngv.v.) nên bằng tiếng anh, đúng chính tả, và có nghĩa.
Tên ở đây bao gồm tên class,tên biến,tên hằngsố, tênhàm, tênfile.

Bạn đang xem: Coding convention là gì

Viết tên bằng tiếng anh trong lúc lập trình, gần nhưlà yêu cầu bắt buộc khi bước vào làm ở bất kì công ty nào. Hãy tậpcho mình một thói quen chuyên nghiệp, từ những việc nhỏ nhất.Đúng chính tả, có thể xem đây là một cách để mọi người luyệnthêm vốn từ vựng của mình.Có nghĩa, tức là tên phải gắn liền với đặc điểm, chức năngcủa đối tượng tương ứng. Ví dụ: $userNameđể thể hiện tên người dùng, $image để thể hiện ảnh đại diện…
Lưu ý: Các biến chạy trong vòng lặp (for, while) không cần tuân theoquy tắc này, vì trên thực tế, các biến $i, $j đã trởthành chuẩn.
Tên hàm/phương thức sẽ theo chuẩn lowerCamelCase, từ đầu tiên viết thường, các từ tiếp sau viết hoa chữ cái đầu.
Nếu có ai hỏi bạn, tại sao tấtcả ngôn ngữ lập trình, đều có kí tự để “comment” một dòng, hoặc một đoạn code (ví dụ trong Javahay C++ là // và /* */). Có lẽ câu trả lời đầutiên của không ít người là để tạm thời xóa bỏ đi đoạn code khôngmuốn sử dụng.
Nhưng đó chỉ là một phần củavấn đề, trên thực tế, ý nghĩa quan trọng hơn rất nhiều của các kítự này là để giải thích, ghi chú, hay nói chung là document cho code. Hãy thử tượngtượng bạn sẽ khó chịu thế nào, khi sử dụng một hàm nào đó củaJava mà lại không có bất kì lời giải thích nào khi rê chuột vàotên hàm!
Vì thế, hãy tập cách document đầy đủ cho bất kì sảnphẩm nào của mình khi code, vì có thể, bạn đã giúp ích rất nhiềucho người đi sau.
Ví dụ:Bạn cần viết một lớp HelloWorl/*** The HelloWorld program implements an application that* simply displays “Hello World!” to the standard output.*
Dòng đầu tiên chính là lờigiải thích cho class, hãy giải thích càng rõ càng tốt, bằng tiếnganh, và… đúng chính tả.
Các dòng phía sau là các thôngtin khác của class, tối thiểu các bạn hãy để tên tác giả theo mẫu trên.

Xem thêm: Couple Là Gì

Cáchàm trong class cũng được thể hiện một cách tương tự, ngoại trừcó phần giải thích thêm cho các thông số truyền vào.Bạn hãy đọc hàm sau đây và cảm nhận sẽ dễ hiểu như thế nào:/*** This method is used to add two integers. This is* a the simplest form of a class method, just to* show the usage of various javadoc Tags.*
return int This returns sum of firstNumber and secondNumber.*/public int addNum(int firstNumber,int secondNumber) return firstNumber+secondNumber;
Đây là điều rất cần thiết,nhất là với người đọc code. Ví dụ, chúng ta cần khai báo các thuộctính tên, tuổi và nghề nghiệp cho class user, đồng thời khai báo mộthằng tên công ty. Chúng ta sẽ thực hiện như sau:
//Company name, same for all user.const WEBSITE_NAME = “thienmaonline.vn”;//User’s nameprivate String userName;//User’s ageprivate int age;
Các dòng xử lí lặp, rẽ nhánh,giải quyết vấn đề… đều phải được giải thích rõ ràng. Hãy xemphiên bản hàm add được trình bày ở trên, với các lời giải thíchrõ ràng:public int addNum(int firstNumber,int secondNumber) // If the first parameter is 0, return 0. if(firstNumber==0) return 0; else // If the second parameter is 0, return 1. if(secondNumber==0) return 1; else return firstNumber+secondNumber;
Ở khíacạnh nào đó, thì một file mã nguồn cũng là một văn bản thuần túy,và hiển nhiên, vẫn có những cách format mà chúng ta phải tuân thủ.Một trong những qui tắc có thể kể ra như sau:Vị trí hai kí tự mở hàm () và kết thúc hàm () tương ứng.Giữa biến và phép toán phải có một khoảng chắn (Ví dụ: a == b thay vì a==b).Chữ cái đầu tiên của câu comment cách kí tự comment một khoảng chắn.
Tấtnhiên, còn khá nhiều qui tắc nhỏ nhặt khác, và chắc chắn sẽ rấtkinh khủng và mất thời gian nếu mỗi người lập trình viên phải tuântheo các qui tắc này.Tuy nhiên, bạn không cần phải nhớ, và cũng không cần phải làm, vìcác IDE sẽ làm giúp bạn.
Chúng ta có qui tắc cuối cùng:Sau khi code xong và thực hiện tất cả các qui tắctrên, format code bằng IDECách format code sẽ khác nhautùy vào IDE, ví dụ, trên các IDE có nhân Eclipse sẽ là Ctrl + Shift + F
, trên Netbeans là Alt + Shift + F.

Xem thêm: Goo Gl Là Gì – Trình Rút Gọn Goo

*

thienmaonline.vnlà cộng đồng của những người học, làm và dạy trong lĩnh vực công nghệ thông tin. thienmaonline.vnhướng tới việc chia sẻ kiến thức và kinh nghiệm góp phần thúc đẩy ngành công nghệ thông tin Việt Nam ngày càng phát triển.

Chuyên mục: Hỏi Đáp

Bạn thấy bài viết thế nào?