Quy Tắc Và Phong Cách Viết Code Trong Lập Trình

Quy tắc và phong cách viết code trong lập trình

Đối với lập trình viên chuyên nghiệp, khi bước vào thế giới lập trình bạn phải học được những quy tắc tối cơ bản về phong cách và quy tắc viết code.

Đối với một lập trình viên, chưa quan tâm bạn viết ngôn ngữ nào nhưng ngôn ngữ bạn viết và phong cách bạn viết mang lại một cách nhìn cho người đọc code của bạn. Còn đối với lập trình viên chuyên nghiệp, khi bước vào thế giới lập trình bạn phải học được những quy tắc tối cơ bản về phong cách và quy tắc viết code.

Bài viết dưới đây chúng ta sẽ nghiên cứu về cách viết code cơ bản của Ngôn ngữ PHP, PHP tiền thân được phát triển lên từ Perl, cách viết code và cách thể hiện code có phần tương ứng với nhau. Trong bài này chúng ta sẽ lấy ngôn ngữ PHP làm ngôn ngữ chủ đạo để thể hiện được quy tắc và phong cách viết code.

1.Cách tổ chức và lưu tên flie, thư mục

Quy tắc đối với thư mục :

Tên thư mục phải trực quan, mô tả được tác dụng của những file nó chứa bên trong và được tối ưu nhất, tức là không dồn tất cả các file vào một thư mục nếu mục đích của file đó không thực sự đúng với mục đích của thư mục.

Tên thư mục không đặt in hoa, tất cả ký tự đều là chữ thường, không sử dụng dấu cách (space) trong khi đặt thư mục, nếu cần thiết sử dụng dấu gạch dưới ( _ ) để đặt tên

Quy tắc đối với File và Đặt tên File :

Đối với tổ chức File: File được lưu phải đúng địa điểm, nằm đúng thư mục mô tả tác dụng của nó, không lưu tại thư mục không liên quan đến mục đích của nó, không lưu file tại thư mục không mô tả rõ ràng mục đích của nó

Đối với đặt tên File: Tên File được lưu phải mô tả được nội dung tối tất yếu của nó (class, function….)

Tên File không sử dụng dấu cách (space), nếu cần thiết sử dụng dấu gạch dưới ( _ )

2. Cách tổ chức, đặt tên cho Fungction, Class

Có thể đối với một số bạn, trong quá trình này đây là kiến thức khó hiểu, vì bạn chưa có căn bản về function và class, dẫu vậy bạn vẫn nên đọc và lưu ý bài viết này để dành cho sau này khi bạn cần đến trong quá trình học.

Cách tổ chức Function, Class

Đối với Class, Function phải khai báo tên có mục đích rõ ràng, mô tả được công việc mà Class (lớp) và các Funtion (phương thức) của nó thực hiện.

Tên Class,Function không bắt đầu bằng số, bắt buộc bắt đầu bằng chữ cái và Viết HOA chữ cái đầu tiên.

Không sử dụng dấu cách (space) cho tên Class, Function. Nếu cần thiết sử dụng dấu gạch dưới ( _ ).

Bắt Buộc mô tả bằng dấu Comment (Sẽ mô tả ở phần sau) về nội dung Class, Function, các biến truyền vào, các biến sẽ trả về.

Cách tổ chức Function khi khai báo theo phong cách không hướng đối tượng

Function phải được khai báo sau tất cả mọi xử lý, thông thường theo cách viết này, function sẽ được đổ dồn về cuối file.

Function vẫn phải tuân theo phong cách đặt tên và khai báo cơ bản.

3. Quy tắc đặt tên biến

- Tên biến phải mô tả rõ ràng nội dung nó sẽ đảm nhận.

- Tất cả phải viết bằng chữ thường

- Không sử dụng dấu cách (space) khi đặt tên, nếu cần thiết sử dụng dấu ( _ )

- Tên biến khai báo có hoặc không cần kiểu dữ liệu (chỉ đối với PHP, các ngôn ngữ khác có quy tắc khác)

- Khi khai báo biến phải sử dụng comment để nêu rõ tác dụng và nội dung biến sẽ chứa

4. Comment trong quá trình viết Code

Đối với tất cả các loại ngôn ngữ, comment trong quá trình viết code rất quan trọng, nó sẽ mô tả được các thông tin và điều mà người lập trình cần lưu ý đối với người đọc và chỉnh sửa code của họ sau này.

-Comment với tất cả Class, Function, Biến, quá trình xử lý điều kiện nào đó.

- Sử dụng comment theo 2 cách : dùng dấu ( //comment content ) hoặc cặp dấu (/* comment content*/)

- Đối với cặp dấu ( //comment content ): Nội dung comment sẽ nằm sau cặp dấu này bắt đầu từ dấu / thứ 2, tác dụng của comment chỉ duy nhất trên dòng đó.

- Đối với cặp dấu (/* comment content*/) : Nội dung comment nằm trong cặp dấu này bắt đầu từ dấu * đầu tiên cho đến dấu * thứ 2, tác dụng của comment này có thể tác dụng trên nhiều dòng, tùy thuộc vào dấu * thứ hai nằm ở dòng nào để kéo dài khoảng cách comment.

- Tất cả nội dung trong comment bao gồm : Biến, Function, Class, Text. Tất cả đều không có tác dụng trong phần comment và không có tác dụng, không hiển thị trong quá trình xử lý

Trên đây là một trong số những quy tắc căn bản bạn phải biết và áp dụng trong quá trình viết code cho một dự án hoặc viết cho một module nào đó khi đi làm. Việc viết đúng các quy tắc sẽ giúp rất nhiều trong việc code nhóm, Nhóm sẽ dễ dàng tiên đoán hoặc dễ dàng hiểu được code của bạn và có cách để lắp ráp phù hợp với nhau. Còn nếu bạn muốn trở thành những lập trình viên giỏi hãy tham gia các khóa học kinh nghiệm lập trình tại Stanford – dạy kinh nghiệm lập trình.

Là đơn vị tiên phong trong lĩnh vực đào tạo các lập trình viên phát triển phần mềm ứng dụng, Công ty CP Stanford – Đào tạo và phát triển công nghệ luôn mong muốn mang tới cho học viên chương trình đào tạo tối ưu nhất giúp các bạn dễ dàng học tập và có thể lựa chọn chương trình học phù hợp nhất với khả năng của mình.

Với phương châm "Học để làm việc", cùng mô hình đào tạo “dạy kinh nghiệm thực tế”, chúng tôi sẽ giúp bạn tiếp cận với môi trường làm việc chuyên nghiệp. Bạn sẽ được cung cấp kiến thức và kinh nghiệm làm việc thực tế, sử dụng thành thạo các công cụ phát triển phần mềm, phát triển kỹ năng làm việc nhóm và có cơ hội tham gia các dự án đang phát triển tại công ty chúng tôi.

Đây cũng là lý do đa phần các học viên tại Stanford – dạy kinh nghiệm lập trình đều có kiến thức chuyên môn tốt và được đánh giá cao trong công việc. Không ít trong số đó đã tạo được sự nghiệp riêng sau những năm đầu khởi nghiệp với nghề.

Và còn rất rất nhiều điểm thú vị khác nữa đang chờ bạn khám phá khi tham gia học kinh nghiệm lập trình tại Stanford. Chi tiết xem tại: các chương trình ưu đãi dành cho học viên tại Stanford.

Nào, hãy liên hệ ngay với chúng tôi theo Hotline: 0866 586 366 – 0963 723 236 hoặc 024 6275 2212 – 024 6662 3355 để được gọi lại tư vấn chi tiết.

Sưu tầm và Tổng hợp

Nhật Lệ ( Stanford - Nâng tầm tri thức)

Tags: học lập trình, khóa học lập trình