Coding convention là gì? Tìm hiểu về coding convention java – TRƯỜNG THPT TRẦN HƯNG ĐẠO

Posted on by mtoplistChuyên mục:Top List

oding convention là gì? Coding convention thường được sử dụng như thế nào trong lập trình? Cùng chúng tôi tìm hiểu về các quy tắc cùng cách sử dụng của Coding convention trong bài viết dưới đây.

Coding convention là gì? 

Coding convention hay quy ước mã hóa là tiêu chuẩn định dạng mã thường được chấp nhận và sử dụng bởi một nhóm các nhà tăng trưởng ứng dụng để san sớt mã một cách thống nhất. Mục tiêu của việc vận dụng và sử dụng tiêu chuẩn là để một người đơn giản hóa việc hiểu mã chương trình và hạn chế tải về bộ nhớ, tư duy và tầm nhìn lúc đọc một chương trình.

Ví dụ về tiêu chuẩn mã hóa là một tập trung các quy ước được vận dụng trong bất kỳ tác phẩm in rộng rãi nào bằng một tiếng nói (ví dụ: tiêu chuẩn C để viết mã, thu được từ viết tắt K&R, xuất phát từ các cuốn sách cổ điển về C của Kernighan và Ritchie). Một ví dụ khác là thư viện hoặc API được sử dụng rộng rãi (ví dụ: việc phân phối ký hiệu Hungary rõ ràng bị tác động bởi việc sử dụng nó trong Windows API và hồ hết các tiêu chuẩn mã hóa để sử dụng Python, ở mức độ này hay mức độ khác, các tiêu chuẩn PEP).

Các nhà tăng trưởng tiếng nói cũng phát hành các hướng dẫn viết mã cụ thể. Ví dụ, các tiêu chuẩn mã hóa C # của Microsoft và các tiêu chuẩn mã hóa Java của Oracle đã được phát hành. Hình thức mã hóa do nhà tăng trưởng đề xuất hoặc được chấp nhận bởi các nguồn nổi tiếng ít nhiều đã được bổ sung và hoàn thiện trong các tiêu chuẩn của doanh nghiệp.

Thông thường, một tiêu chuẩn quy ước mã hóa mô tả:

  • Cách chọn tên và trường hợp ký tự được sử dụng cho tên biến và các số nhận dạng khác.

  • Viết kiểu của biến trong mã định danh của nó (ký hiệu tiếng Hungary) và một tập trung các ký tự (chữ thường, chữ in hoa, “Lạc Đà”, “lạc đà” với chữ thường), sử dụng dấu gạch dưới để phân tích các từ.

  • Kiểu thụt lề cho các khối logic – có sử dụng các tab hay ko, độ rộng thụt lề.

  • Một phương pháp để đặt các dấu ngoặc xung quanh các khối logic.

  • Việc sử dụng khoảng trong trắng thiết kế các biểu thức logic và số học.

  • Bình luận và việc sử dụng các bình luận tài liệu.

  • Các quy ước đặt tên biến, lớp và tệp,

  • Tuyên bố và các phương pháp hay nhất về việc sử dụng chúng.

  • Tổ chức hồ sơ.

  • Khai báo các lớp và giao diện.

  • Thực hành lập trình.

Ngoài tiêu chuẩn, những điều sau được ngụ ý: 

  • Hạn chế kích thước của mã theo chiều ngang (để nó vừa với màn hình) và chiều dọc (để tất cả mã của tệp được lưu trong bộ nhớ).

  • Cũng như một hàm hoặc phương thức với kích thước của một màn hình (đối với một số tiếng nói lập trình).

Lý do nên sử dụng coding convention là gì

Các tiêu chuẩn mã hóa rất quan trọng đối với các nhà tăng trưởng ứng dụng vì một số lý do:

  • 40% – 80% tổng chi phí của ứng dụng được chi cho việc bảo trì nó.

  • Ứng dụng hầu như ko bao giờ được hỗ trợ đầy đủ bởi tác giả gốc của nó.

  • Các tiêu chuẩn mã hóa cải thiện khả năng đọc của ứng dụng bằng cách cho phép các nhà tăng trưởng hiểu mã mới nhanh hơn và tốt hơn.

  • Giống như bất kỳ thành phầm nào khác, ứng dụng phải được “đóng gói tốt” và sạch sẽ.

Như các nhà tăng trưởng của Svitla Systems xem xét, “Dự án nên được viết theo cùng một phong cách. Điều này là cần thiết để cải thiện hỗ trợ và tăng vận tốc liên quan tới các nhà tăng trưởng mới và ngăn chặn việc viết ra các loại lỗi mới hoặc sử dụng các mẫu ko cần thiết trong dự án, những nơi nhưng mà nó ko cần thiết vào lúc này. “

Theo kinh nghiệm của chúng tôi, quy ước mã hóa cải thiện khả năng đọc mã, tạo điều kiện thuận tiện cho việc giới thiệu các nhà tăng trưởng mới vào dự án và đơn giản hóa việc viết mã, bởi vì có sự hiểu biết về phong cách nó nên được viết và do đó ít cấu trúc lại sau này (nếu các tiêu chuẩn tốt viết với kiến ​​trúc và cấu trúc).

Các lý do chính để sử dụng quy ước mã hóa như sau:

  • Các quy tắc viết mã tương tự giúp các đồng nghiệp khác dễ hiểu.

  • Dễ dàng hiểu mã hơn trong một năm hoặc 5 năm nhưng mà ko cần đọc từng thuật ngữ.

  • Bạn luôn biết vị trí của các lớp và tệp nhất mực trong một dự án lớn.

Điều này có thể được so sánh với một máy tính để bàn: Nếu mọi thứ được sắp xếp gọn ghẽ, nó rất dễ dàng để làm việc. Nếu có một mớ hỗn độn, thì mọi thứ nhỏ nhặt phải mất nhiều thời kì.

Thông thường, các quy ước viết mã cho mỗi nhóm là không giống nhau, và đôi lúc rất không giống nhau giữa các dự án. Chúng tôi cần chúng để các nhà tăng trưởng khác có thể dễ dàng tìm ra mã và nói chung, mã được viết bởi các thành viên trong nhóm không giống nhau trông giống nhau trong dự án và có thể bảo trì và hỗ trợ.

Đối với các tiếng nói lập trình không giống nhau, có các quy ước mã hóa. Những quy ước mã hóa này ko phải là tuyệt đối. Trong mỗi dự án và mỗi doanh nghiệp, các tiêu chuẩn có thể được tăng trưởng cho quy ước mã hóa. Đây là một biểu đồ ví dụ:

Tiếng nói lập trình

Quy ước mã hóa

C

Kiểu mã hóa GNOME

C ++

Hướng dẫn kiểu Google C ++

C#

Quy ước mã hóa C # của Microsoft

Go

Các dụng cụ quy ước đặt tên và định dạng mã trong Golang

Java

Quy ước mã Java của Oracle

Javascript

Hướng dẫn về kiểu Javascript của Google

Python

PEP8

PHP

PSR-2 

Ruby

Clearwater Ruby Coding Guidelin

Scala

Hướng dẫn phong cách Scala

Swift

Hướng dẫn về phong cách Swift của Google

Sử dụng Coding convention ở đâu và lúc nào?

Cần xem xét rằng quy ước mã hóa ko chỉ là định dạng. Trả lời câu hỏi lúc nào sử dụng quy ước mã hóa, tùy chọn dễ nhất là lúc tự viết mã. Điều này cho phép tất cả những người tham gia dự án làm quen với quy ước và phối hợp tất cả các yêu cầu cần thiết.

Mã hóa quy ước phải được vận dụng bởi cả một nhà tăng trưởng và một nhóm tăng trưởng. Bất kể trình độ của các nhà tăng trưởng, họ phải sử dụng quy ước mã hóa; điều này làm cho quá trình tăng trưởng ứng dụng ổn định hơn và mã trở thành tốt hơn.

Xem xét rằng trong quá trình thẩm định ngang hàng ứng dụng, việc tuân thủ quy ước mã hóa là rất quan trọng. Quá trình xác minh quy ước mã hóa cũng có thể được thực hiện trong quá trình tái cấu trúc. Điều này cải thiện khả năng đọc mã và làm cho toàn thể dự án thống nhất hơn.

Tiêu chuẩn hóa các quy ước mã hóa có thể được thông qua ở các ngành độ sau:

  • Cấp độ dự án

  • Cấp doanh nghiệp

  • Cấp tập thể nhà tăng trưởng

  • Mức tiêu chuẩn ngành

  • Cấp độ ISO

Coding Convention Java là gì

Coding Convention Java được Oracle xác định trong tài liệu quy ước mã hóa. Tóm lại, các quy ước này yêu cầu người dùng sử dụng lúc xác định các lớp, phương thức hoặc biến. Các class khởi đầu bằng một chữ cái viết hoa và phải là danh từ, như Calendar Dialog View. Đối với các phương thức, tên phải là động từ ở dạng mệnh lệnh, như get Brake System Type, và phải khởi đầu bằng một chữ cái viết thường.

Điều quan trọng là phải làm quen và tuân theo các quy ước mã hóa, để mã được viết bởi nhiều lập trình viên sẽ xuất hiện giống nhau. Các dự án có thể xác định lại các quy ước mã tiêu chuẩn để thích hợp hơn với nhu cầu của họ. Các ví dụ bao gồm danh sách các từ viết tắt được phép, vì chúng thường có thể làm cho mã khó hiểu đối với các nhà thiết kế khác. Tài liệu phải luôn đi kèm với mã.

Một ví dụ từ các quy ước mã hóa là cách xác định một hằng số. Hằng số phải được viết bằng chữ in hoa trong Java, trong đó các từ được phân tích bằng ký tự gạch dưới (‘_’). Trong các quy ước mã hóa Java, một hằng số là một static final trường trong một lớp.

Lý do cho sự chuyển hướng này là Java ko phải là 100% hướng nhân vật và phân biệt giữa các kiểu “đơn giản” và “phức tạp”. Những điều này sẽ được xử lý cụ thể trong các phần sau. Một ví dụ cho một kiểu đơn giản là byte kiểu. Một ví dụ cho kiểu phức tạp là một lớp. Một tập trung con của các kiểu phức tạp là các lớp ko thể sửa đổi sau lúc tạo, như a String, là một ghép các ký tự.

Ví dụ: hãy xem xét các “hằng số” sau:

    1. hạng công cộng MotorVehicle

      {

    2.  

      / ** Số lượng động cơ * /

    3.  

      private static final

      int

      MOTORS

      = 1

      ;

    4.  

      / ** Tên động cơ * /

    5.  

      private static final

      String MOTOR_NAME

      =

      “Mercedes V8”

      ;

    6.  

      / ** Nhân vật động cơ * /

    7.  

      private static final

      Motor THE_MOTOR

      =

      new

      MercedesMotor ();

    8.  

      / **

  •   * Người xây dựng

 

  1.  

    public

    MotorVehicle

    () {

  2.    ĐỘNG CƠ

    = 2

    ;                    

    // Đưa ra lỗi cú pháp vì MOTORS đã được gán một trị giá.

  3.    THE_MOTOR

    =

    ToshibaMotor

    mới

    ();

    // Đưa ra lỗi cú pháp vì THE_MOTOR đã được gán một trị giá.

     

  4.    MOTOR_NAME .

    toLowercase

    ();      

    // Ko đưa ra lỗi cú pháp vì nó trả về một Chuỗi mới thay vì thay đổi biến MOTOR_NAME.

  5.    THE_MOTOR .

    fillFuel

    (

    20,5

    );      

    // Ko đưa ra lỗi cú pháp, vì nó thay đổi một biến trong nhân vật động cơ, chứ ko phải chính biến đó.

  6. }

  7. }

Coding convention C#

Các quy ước mã hóa phục vụ các mục tiêu sau:

  • Chúng tạo ra một cái nhìn nhất quán cho mã, để người đọc có thể tập trung vào nội dung chứ ko phải bố cục.

  • Chúng cho phép người đọc hiểu mã nhanh hơn bằng cách đưa ra các giả thiết dựa trên kinh nghiệm trước đó.

  • Chúng tạo điều kiện thuận tiện cho việc sao chép, thay đổi và duy trì mã.

  • Họ chứng minh các phương pháp hay nhất của C #.

Có một số quy ước đặt tên cần xem xét lúc viết mã C #.

Trong các ví dụ sau, bất kỳ hướng dẫn nào liên quan tới các phần tử được ghi lại public cũng có thể vận dụng lúc làm việc với protected và protected internal các phần tử, tất cả đều nhằm mục tiêu hiển thị cho người gọi bên ngoài.

Các quy tắc trong Coding convention C#

  1. Quy tắc đặt tên.

Có 3 kiểu đặt tên thông dụng nhất

KiểuMô tảVí dụ

Pascal Case

Chữ cái trước tiên trong từ định danh và chữ cái trước tiên của mỗi từ nối theo sau phải được viết hoa. Sử dụng Pascal Case để đặt tên cho một tên có từ 3 ký tự trở lên.

Coding Convention

Camel Case

Chữ cái trước tiên trong từ định danh là chữ thường và chữ cái trước tiên của mối từ nối theo sau phải được viết hoa.

Coding Convention

Uppercase

Tất cả các ký tự trong từ định danh phải được viết hoa. Sử dụng quy tắc này đối với tên định danh có từ 2 ký tự trở xuống

System.IO

  1. Tiền tố một số control.

Buộc phải đặt tên cho tất cả các control có tham gia xử lý dưới nền. Một số control được đặt theo kiểu Pascal với phần tiền tố.

  1. Quy ước viết câu lệnh.

Mỗi câu lệnh riêng rẽ trên một dòng.

  1. Khối mã nguồn.

Sử dụng cặp dấu { } để ghi lại một khối mã nguồn. Mỗi dấu ngoặc nằm trên một dòng (Ngoại lệ, kiểu enum, tính chất gọn hoặc khởi tạo trị giá cho mảng có thể ko cần).

Trong các lệnh if, for, foreach, … nếu chỉ có một lệnh thì có thể ko cần ghi lại khối mã nguồn. 

  1. Thụt đầu dòng và cách khoảng

  • Viết cách vào một khoảng tab đối với các lệnh nằm trong khối lệnh { }.

  • Viết cách vào một khoảng tab đối với lệnh ngay sau if, else, while, for, foreach.

  • Viết cách một khoảng trắng xung quanh các toán tử 2 ngôi và 3 ngôi.

  • Viết cách một khoảng trắng sau dấu “,” và “;”.

  1. Chú thích.

Nên comment trên những đoạn code khó hiểu hoặc công dụng đặc trưng. Tiếng nói sử dụng để chú thích phải đồng bộ xuyên suốt chương trình. Chọn một trong hai tiếng nói: tiếng Việt Unicode có dấu hoặc tiếng Anh.

Quy định chú thích:

  • Chỉ sử dụng // và /// để chú thích. Ko dùng /* */.

  • Có chú thích trên đầu mỗi file source code mô tả chương trình, công dụng của chương trình, tác giả, v.v…

  • Khối xử lý dữ liệu: Có chú thích trên mỗi class, mỗi phương thức, mỗi tính chất của class mô tả công dụng, thông số, v.v…

  • Khối xử lý giao diện: Có chú thích mô tả công dụng trên mỗi phương thức ko phải event, hàm Main.

Các kiểu chú thích:

  • Chú thích đơn giản.

  • Đoạn code phức tạp.

  • Mô tả trong thân hàm.

  • Mô tả field.

  • Đoạn code được người ko phải tác giả sửa đổi.

  1. Tiếng nói sử dụng.

Xoành xoạch sử dụng kiểu dữ liệu C# thay vì kiểu dữ liệu .NET.

Coding convention Laravel

Laravel là một dự án mã nguồn mở và bất kỳ người nào cũng có thể đóng góp cho Laravel để cải thiện nó. Chúng tôi hoan nghênh những người đóng góp, bất kể trình độ kỹ năng, giới tính, chủng tộc, tôn giáo hoặc quốc tịch. Có một tập thể nhiều chủng loại, sôi động là một trong những trị giá mấu chốt của phạm vi!

Để khuyến khích sự hợp tác tích cực, Laravel hiện chỉ chấp nhận các yêu cầu chứ ko phải báo cáo lỗi. “Báo cáo lỗi” có thể được gửi dưới dạng một yêu cầu có chứa một bài rà soát đơn vị ko đạt. Ngoài ra, một bản trình diễn về lỗi trong ứng dụng Laravel có thể được gửi dưới dạng một yêu cầu tới kho lưu trữ Laravel chính . Một thử nghiệm đơn vị hoặc ứng dụng ko thành công hỗ trợ cho nhóm tăng trưởng “chứng cứ” rằng lỗi tồn tại và sau lúc nhóm tăng trưởng khắc phục lỗi, nó nhập vai trò như một chỉ báo đáng tin tưởng rằng lỗi vẫn được khắc phục.

Mã nguồn Laravel được quản lý trên Github và có các kho lưu trữ cho mỗi dự án Laravel:

  • Khung Laravel.

  • Ứng dụng Laravel.

  • Tài liệu Laravel.

  • Thu ngân Laravel.

  • Đặc phái viên Laravel.

  • Laravel Homestead.

  • Laravel Homestead Build Scripts.

  • Trang web Laravel.

  • Nghệ thuật Laravel.

Coding convention PHP

Các tiêu chuẩn mã hóa PHP này dành cho tập thể WordPress nói chung. Chúng là buộc phải đối với WordPress Core và chúng tôi khuyến khích bạn sử dụng chúng cho các chủ đề và plugin của mình.

Cũng xem Tiêu chuẩn tài liệu nội tuyến PHP  tại đây:

Mở và đóng thẻ PHP

Lúc nhúng các đoạn mã PHP nhiều dòng trong một khối HTML, các thẻ mở và đóng PHP phải nằm trên một dòng của chính chúng.

Đúng (Nhiều dòng):

1

2

3

4

5

6

7

8

9

10

11

12

13

14

function foo() {

?>

<div>

<?php

echo esc_html(

bar(

$baz,

$bat

)

);

?>

</div>

<?php

}

Đúng (Dòng đơn):

1

<input name=”<?php echo esc_attr( $name ); ?>” />

Ko đúng:

1

2

3

if ( $a === $b ) { ?>

<some html>

<?php }

Ko có thẻ PHP viết tắt

Quan trọng: Ko bao giờ sử dụng thẻ khởi đầu PHP viết tắt. Luôn sử dụng các thẻ PHP đầy đủ. Chuẩn xác:

1

2

<?php … ?>

<?php echo esc_html( $var ); ?>

Ko đúng:

1

2

<? … ?>

<?= esc_html( $var ) ?>

Quy ước đặt tên

Sử dụng các chữ cái thường trong tên biến, hành động / bộ lọc và hàm (ko bao giờ camelCase). Phân tích các từ qua dấu gạch dưới. Đừng viết tắt tên biến một cách ko cần thiết; để mã rõ ràng và tự ghi lại.

1

function some_name( $some_variable ) { […] }

Tên lớp nên sử dụng các từ viết hoa được phân tích bằng dấu gạch dưới. Mọi từ viết tắt đều phải là chữ hoa.

1

2

class Walker_Category extends Walker { […] }

class WP_HTTP { […] }

Các hằng số phải ở dạng chữ hoa với dấu gạch dưới cách trở các từ:

1

define( ‘DOING_AJAX’, true );

Các tệp phải được đặt tên mô tả bằng cách sử dụng các chữ cái thường. Dấu gạch nối nên cách trở các từ.

Tên tệp class phải dựa trên tên class có thêm chữ class – viết trước và dấu gạch dưới trong tên lớp được thay thế bằng dấu gạch ngang, ví dụ WP_Error: trở thành:

Tiêu chuẩn đặt tên tệp này dành cho tất cả các tệp hiện nay và mới có các lớp. Có một ngoại lệ đối với quy tắc này cho ba tệp kế thừa : class.wp-dependencies.php,. Các tệp đó được thêm vào trước , một dấu chấm sau lớp từ thay vì dấu gạch ngang. class.wp-scripts.phpclass.wp-styles.phpclass.

Các tệp chứa thẻ mẫu trong thư mục wp-includes nên được – template thêm vào cuối tên để dễ thấy.

Coding convention in C

Một tệp Coding convention in C bao gồm các phần không giống nhau nên được phân tích bằng một số dòng trống. Mặc dù ko có giới hạn độ dài tối đa cho các tệp nguồn, nhưng các tệp có hơn 1000 dòng sẽ rất kềnh càng để xử lý. Trình thay đổi có thể ko có đủ ko gian tạm thời để thay đổi tệp, quá trình biên dịch diễn ra chậm hơn, v.v. Nhiều hàng dấu hoa thị, ví dụ, hiển thị ít thông tin so với thời kì cần cuộn qua và ko được khuyến khích. Các dòng dài hơn 79 cột ko được xử lý tốt bởi tất cả các thiết bị đầu cuối và nên tránh nếu có thể. Các dòng quá dài do thụt lề sâu thường là một triệu chứng của mã có tổ chức kém. Dưới đây là các quy ước cần biết lúc viết Coding convention in C:

Quy ước đặt tên tệp

Tên tệp được tạo thành từ tên cơ sở, dấu chấm và hậu tố tùy chọn. Ký tự trước tiên của tên phải là một chữ cái và tất cả các ký tự (trừ dấu chấm) phải là chữ thường và số. Tên cơ sở phải có tám ký tự trở xuống và hậu tố phải có ba ký tự trở xuống (bốn, nếu bạn bao gồm dấu chấm). Các quy tắc này vận dụng cho cả tệp chương trình và tệp mặc định được chương trình sử dụng và tạo ra (ví dụ: “rogue.sav”).

Một số trình biên dịch và dụng cụ yêu cầu các quy ước hậu tố nhất mực cho tên của tệp [5]. Các hậu tố sau là buộc phải:

  • Tên tệp nguồn C phải kết thúc bằng.c.

  • Tên tệp nguồn của trình lắp ráp phải kết thúc bằng.s.

  • Các quy ước sau đây được tuân thủ rộng rãi:

    • Tên tệp nhân vật có thể vận chuyển lại kết thúc bằng.o.

    • Bao gồm các tên tệp tiêu đề kết thúc bằng .h. Một quy ước thay thế có thể thích hợp hơn trong môi trường đa tiếng nói là sử dụng hậu tố cho cả loại tiếng nói và .h(ví dụ: foo.c.h hoặc foo.ch).

    • Tên tệp nguồn yacc kết thúc bằng.y.

    • Tên tệp nguồn Lex kết thúc bằng.l.

  • C ++ có các quy ước hậu tố phụ thuộc vào trình biên dịch, bao gồm .c,, và . Vì nhiều mã C cũng là mã C ++ nên ko có giải pháp rõ ràng nào ở đây…c.cc.c.c.C

Ngoài ra, thông thường sử dụng Makefile(ko makefile) cho tệp điều khiển cho make (đối với các hệ thống hỗ trợ nó) và “README” để tóm tắt nội dung của thư mục hoặc cây thư mục.

File chương trình

Trật tự được đề xuất của các phần cho một tệp chương trình như sau:

  • Trước tiên trong tệp là đoạn mở đầu cho biết những gì có trong tệp đó. Mô tả về mục tiêu của các nhân vật trong tệp (cho dù chúng là hàm, khai báo hoặc khái niệm dữ liệu bên ngoài hoặc một cái gì đó khác) hữu ích hơn một danh sách tên nhân vật. Phần mở đầu có thể tùy ý chứa (các) tác giả, thông tin kiểm soát sửa đổi, tài liệu tham khảo,…

  • Bất kỳ tệp tiêu đề bao gồm phải là tiếp theo. Nếu bao gồm vì một lý do mập mờ, lý do nên được ghi chú. Trong hồ hết các trường hợp, hệ thống bao gồm các tệp như stdio.h nên được đưa vào trước lúc người dùng đưa vào tệp.

  • Tiếp theo là bất kỳ khái niệm và typedef nào vận dụng cho toàn thể tệp. Một trật tự thông thường là phải có macro “hằng số” trước, sau đó tới macro “hàm”, sau đó là typedefs và enums. 

  • Tiếp theo là khai báo dữ liệu tổng thể (bên ngoài), thường theo trật tự: externs, ko static global, static global. Nếu một tập trung các khái niệm vận dụng cho một phần dữ liệu tổng thể cụ thể (chẳng hạn như một từ flags), các khái niệm phải nằm ngay sau khai báo dữ liệu hoặc được nhúng trong các khai báo cấu trúc, được thụt vào để đặt các khái niệm sâu hơn một cấp so với từ khóa trước tiên của tuyên bố nhưng mà họ vận dụng. 

  • Các công dụng tới sau cuối và phải theo một trật tự có ý nghĩa nào đó. Giống như các công dụng nên xuất hiện cùng nhau. Phương pháp tiếp cận “theo chiều rộng” (các công dụng ở mức độ trừu tượng tương tự với nhau) được ưu tiên hơn so với phương pháp trước tiên theo chiều sâu (các công dụng được xác định càng sớm càng tốt trước hoặc sau cuộc gọi của chúng). Sự phán xét đáng cân nhắc được kêu gọi ở đây. Nếu xác định số lượng lớn các hàm tiện ích độc lập về cơ bản, hãy xem xét trật tự bảng chữ cái.

Trên đây là tổng hợp các thông tin liên quan tới coding convention là gì cùng tổng hợp các thông tin, quy định về các tiêu chuẩn quy ước mã hóa cụ thể trong từng tiếng nói lập trình. Kỳ vọng rằng qua bài viết này các bạn sẽ hiểu hơn về coding convention là gì cùng các quy tắc của coding convention.

Xem thêm: Tổng hợp thông tin về tính chất của cạnh tranh là gì

Thắc mắc –

xem thêm thông tin chi tiết về Coding convention là gì? Tìm hiểu về coding convention java

Coding convention là gì? Tìm hiểu về coding convention java

Hình Ảnh về: Coding convention là gì? Tìm hiểu về coding convention java

Video về: Coding convention là gì? Tìm hiểu về coding convention java

Wiki về Coding convention là gì? Tìm hiểu về coding convention java

Coding convention là gì? Tìm hiểu về coding convention java -

oding convention là gì? Coding convention thường được sử dụng như thế nào trong lập trình? Cùng chúng tôi tìm hiểu về các quy tắc cùng cách sử dụng của Coding convention trong bài viết dưới đây.

Coding convention là gì? 

Coding convention hay quy ước mã hóa là tiêu chuẩn định dạng mã thường được chấp nhận và sử dụng bởi một nhóm các nhà tăng trưởng ứng dụng để san sớt mã một cách thống nhất. Mục tiêu của việc vận dụng và sử dụng tiêu chuẩn là để một người đơn giản hóa việc hiểu mã chương trình và hạn chế tải về bộ nhớ, tư duy và tầm nhìn lúc đọc một chương trình.

Ví dụ về tiêu chuẩn mã hóa là một tập trung các quy ước được vận dụng trong bất kỳ tác phẩm in rộng rãi nào bằng một tiếng nói (ví dụ: tiêu chuẩn C để viết mã, thu được từ viết tắt K&R, xuất phát từ các cuốn sách cổ điển về C của Kernighan và Ritchie). Một ví dụ khác là thư viện hoặc API được sử dụng rộng rãi (ví dụ: việc phân phối ký hiệu Hungary rõ ràng bị tác động bởi việc sử dụng nó trong Windows API và hồ hết các tiêu chuẩn mã hóa để sử dụng Python, ở mức độ này hay mức độ khác, các tiêu chuẩn PEP).

Các nhà tăng trưởng tiếng nói cũng phát hành các hướng dẫn viết mã cụ thể. Ví dụ, các tiêu chuẩn mã hóa C # của Microsoft và các tiêu chuẩn mã hóa Java của Oracle đã được phát hành. Hình thức mã hóa do nhà tăng trưởng đề xuất hoặc được chấp nhận bởi các nguồn nổi tiếng ít nhiều đã được bổ sung và hoàn thiện trong các tiêu chuẩn của doanh nghiệp.

Thông thường, một tiêu chuẩn quy ước mã hóa mô tả:

  • Cách chọn tên và trường hợp ký tự được sử dụng cho tên biến và các số nhận dạng khác.

  • Viết kiểu của biến trong mã định danh của nó (ký hiệu tiếng Hungary) và một tập trung các ký tự (chữ thường, chữ in hoa, “Lạc Đà”, “lạc đà” với chữ thường), sử dụng dấu gạch dưới để phân tích các từ.

  • Kiểu thụt lề cho các khối logic – có sử dụng các tab hay ko, độ rộng thụt lề.

  • Một phương pháp để đặt các dấu ngoặc xung quanh các khối logic.

  • Việc sử dụng khoảng trong trắng thiết kế các biểu thức logic và số học.

  • Bình luận và việc sử dụng các bình luận tài liệu.

  • Các quy ước đặt tên biến, lớp và tệp,

  • Tuyên bố và các phương pháp hay nhất về việc sử dụng chúng.

  • Tổ chức hồ sơ.

  • Khai báo các lớp và giao diện.

  • Thực hành lập trình.

Ngoài tiêu chuẩn, những điều sau được ngụ ý: 

  • Hạn chế kích thước của mã theo chiều ngang (để nó vừa với màn hình) và chiều dọc (để tất cả mã của tệp được lưu trong bộ nhớ).

  • Cũng như một hàm hoặc phương thức với kích thước của một màn hình (đối với một số tiếng nói lập trình).

Lý do nên sử dụng coding convention là gì

Các tiêu chuẩn mã hóa rất quan trọng đối với các nhà tăng trưởng ứng dụng vì một số lý do:

  • 40% – 80% tổng chi phí của ứng dụng được chi cho việc bảo trì nó.

  • Ứng dụng hầu như ko bao giờ được hỗ trợ đầy đủ bởi tác giả gốc của nó.

  • Các tiêu chuẩn mã hóa cải thiện khả năng đọc của ứng dụng bằng cách cho phép các nhà tăng trưởng hiểu mã mới nhanh hơn và tốt hơn.

  • Giống như bất kỳ thành phầm nào khác, ứng dụng phải được “đóng gói tốt” và sạch sẽ.

Như các nhà tăng trưởng của Svitla Systems xem xét, “Dự án nên được viết theo cùng một phong cách. Điều này là cần thiết để cải thiện hỗ trợ và tăng vận tốc liên quan tới các nhà tăng trưởng mới và ngăn chặn việc viết ra các loại lỗi mới hoặc sử dụng các mẫu ko cần thiết trong dự án, những nơi nhưng mà nó ko cần thiết vào lúc này. “

Theo kinh nghiệm của chúng tôi, quy ước mã hóa cải thiện khả năng đọc mã, tạo điều kiện thuận tiện cho việc giới thiệu các nhà tăng trưởng mới vào dự án và đơn giản hóa việc viết mã, bởi vì có sự hiểu biết về phong cách nó nên được viết và do đó ít cấu trúc lại sau này (nếu các tiêu chuẩn tốt viết với kiến ​​trúc và cấu trúc).

Các lý do chính để sử dụng quy ước mã hóa như sau:

  • Các quy tắc viết mã tương tự giúp các đồng nghiệp khác dễ hiểu.

  • Dễ dàng hiểu mã hơn trong một năm hoặc 5 năm nhưng mà ko cần đọc từng thuật ngữ.

  • Bạn luôn biết vị trí của các lớp và tệp nhất mực trong một dự án lớn.

Điều này có thể được so sánh với một máy tính để bàn: Nếu mọi thứ được sắp xếp gọn ghẽ, nó rất dễ dàng để làm việc. Nếu có một mớ hỗn độn, thì mọi thứ nhỏ nhặt phải mất nhiều thời kì.

Thông thường, các quy ước viết mã cho mỗi nhóm là không giống nhau, và đôi lúc rất không giống nhau giữa các dự án. Chúng tôi cần chúng để các nhà tăng trưởng khác có thể dễ dàng tìm ra mã và nói chung, mã được viết bởi các thành viên trong nhóm không giống nhau trông giống nhau trong dự án và có thể bảo trì và hỗ trợ.

Đối với các tiếng nói lập trình không giống nhau, có các quy ước mã hóa. Những quy ước mã hóa này ko phải là tuyệt đối. Trong mỗi dự án và mỗi doanh nghiệp, các tiêu chuẩn có thể được tăng trưởng cho quy ước mã hóa. Đây là một biểu đồ ví dụ:

Tiếng nói lập trình

Quy ước mã hóa

C

Kiểu mã hóa GNOME

C ++

Hướng dẫn kiểu Google C ++

C#

Quy ước mã hóa C # của Microsoft

Go

Các dụng cụ quy ước đặt tên và định dạng mã trong Golang

Java

Quy ước mã Java của Oracle

Javascript

Hướng dẫn về kiểu Javascript của Google

Python

PEP8

PHP

PSR-2 

Ruby

Clearwater Ruby Coding Guidelin

Scala

Hướng dẫn phong cách Scala

Swift

Hướng dẫn về phong cách Swift của Google

Sử dụng Coding convention ở đâu và lúc nào?

Cần xem xét rằng quy ước mã hóa ko chỉ là định dạng. Trả lời câu hỏi lúc nào sử dụng quy ước mã hóa, tùy chọn dễ nhất là lúc tự viết mã. Điều này cho phép tất cả những người tham gia dự án làm quen với quy ước và phối hợp tất cả các yêu cầu cần thiết.

Mã hóa quy ước phải được vận dụng bởi cả một nhà tăng trưởng và một nhóm tăng trưởng. Bất kể trình độ của các nhà tăng trưởng, họ phải sử dụng quy ước mã hóa; điều này làm cho quá trình tăng trưởng ứng dụng ổn định hơn và mã trở thành tốt hơn.

Xem xét rằng trong quá trình thẩm định ngang hàng ứng dụng, việc tuân thủ quy ước mã hóa là rất quan trọng. Quá trình xác minh quy ước mã hóa cũng có thể được thực hiện trong quá trình tái cấu trúc. Điều này cải thiện khả năng đọc mã và làm cho toàn thể dự án thống nhất hơn.

Tiêu chuẩn hóa các quy ước mã hóa có thể được thông qua ở các ngành độ sau:

  • Cấp độ dự án

  • Cấp doanh nghiệp

  • Cấp tập thể nhà tăng trưởng

  • Mức tiêu chuẩn ngành

  • Cấp độ ISO

Coding Convention Java là gì

Coding Convention Java được Oracle xác định trong tài liệu quy ước mã hóa. Tóm lại, các quy ước này yêu cầu người dùng sử dụng lúc xác định các lớp, phương thức hoặc biến. Các class khởi đầu bằng một chữ cái viết hoa và phải là danh từ, như Calendar Dialog View. Đối với các phương thức, tên phải là động từ ở dạng mệnh lệnh, như get Brake System Type, và phải khởi đầu bằng một chữ cái viết thường.

Điều quan trọng là phải làm quen và tuân theo các quy ước mã hóa, để mã được viết bởi nhiều lập trình viên sẽ xuất hiện giống nhau. Các dự án có thể xác định lại các quy ước mã tiêu chuẩn để thích hợp hơn với nhu cầu của họ. Các ví dụ bao gồm danh sách các từ viết tắt được phép, vì chúng thường có thể làm cho mã khó hiểu đối với các nhà thiết kế khác. Tài liệu phải luôn đi kèm với mã.

Một ví dụ từ các quy ước mã hóa là cách xác định một hằng số. Hằng số phải được viết bằng chữ in hoa trong Java, trong đó các từ được phân tích bằng ký tự gạch dưới (‘_’). Trong các quy ước mã hóa Java, một hằng số là một static final trường trong một lớp.

Lý do cho sự chuyển hướng này là Java ko phải là 100% hướng nhân vật và phân biệt giữa các kiểu “đơn giản” và “phức tạp”. Những điều này sẽ được xử lý cụ thể trong các phần sau. Một ví dụ cho một kiểu đơn giản là byte kiểu. Một ví dụ cho kiểu phức tạp là một lớp. Một tập trung con của các kiểu phức tạp là các lớp ko thể sửa đổi sau lúc tạo, như a String, là một ghép các ký tự.

Ví dụ: hãy xem xét các “hằng số” sau:

    1. hạng công cộng MotorVehicle

      {

    2.  

      / ** Số lượng động cơ * /

    3.  

      private static final

      int

      MOTORS

      = 1

      ;

    4.  

      / ** Tên động cơ * /

    5.  

      private static final

      String MOTOR_NAME

      =

      “Mercedes V8”

      ;

    6.  

      / ** Nhân vật động cơ * /

    7.  

      private static final

      Motor THE_MOTOR

      =

      new

      MercedesMotor ();

    8.  

      / **

  •   * Người xây dựng

 

  1.  

    public

    MotorVehicle

    () {

  2.    ĐỘNG CƠ

    = 2

    ;                    

    // Đưa ra lỗi cú pháp vì MOTORS đã được gán một trị giá.

  3.    THE_MOTOR

    =

    ToshibaMotor

    mới

    ();

    // Đưa ra lỗi cú pháp vì THE_MOTOR đã được gán một trị giá.

     

  4.    MOTOR_NAME .

    toLowercase

    ();      

    // Ko đưa ra lỗi cú pháp vì nó trả về một Chuỗi mới thay vì thay đổi biến MOTOR_NAME.

  5.    THE_MOTOR .

    fillFuel

    (

    20,5

    );      

    // Ko đưa ra lỗi cú pháp, vì nó thay đổi một biến trong nhân vật động cơ, chứ ko phải chính biến đó.

  6. }

  7. }

Coding convention C#

Các quy ước mã hóa phục vụ các mục tiêu sau:

  • Chúng tạo ra một cái nhìn nhất quán cho mã, để người đọc có thể tập trung vào nội dung chứ ko phải bố cục.

  • Chúng cho phép người đọc hiểu mã nhanh hơn bằng cách đưa ra các giả thiết dựa trên kinh nghiệm trước đó.

  • Chúng tạo điều kiện thuận tiện cho việc sao chép, thay đổi và duy trì mã.

  • Họ chứng minh các phương pháp hay nhất của C #.

Có một số quy ước đặt tên cần xem xét lúc viết mã C #.

Trong các ví dụ sau, bất kỳ hướng dẫn nào liên quan tới các phần tử được ghi lại public cũng có thể vận dụng lúc làm việc với protected và protected internal các phần tử, tất cả đều nhằm mục tiêu hiển thị cho người gọi bên ngoài.

Các quy tắc trong Coding convention C#

  1. Quy tắc đặt tên.

Có 3 kiểu đặt tên thông dụng nhất

KiểuMô tảVí dụ

Pascal Case

Chữ cái trước tiên trong từ định danh và chữ cái trước tiên của mỗi từ nối theo sau phải được viết hoa. Sử dụng Pascal Case để đặt tên cho một tên có từ 3 ký tự trở lên.

Coding Convention

Camel Case

Chữ cái trước tiên trong từ định danh là chữ thường và chữ cái trước tiên của mối từ nối theo sau phải được viết hoa.

Coding Convention

Uppercase

Tất cả các ký tự trong từ định danh phải được viết hoa. Sử dụng quy tắc này đối với tên định danh có từ 2 ký tự trở xuống

System.IO

  1. Tiền tố một số control.

Buộc phải đặt tên cho tất cả các control có tham gia xử lý dưới nền. Một số control được đặt theo kiểu Pascal với phần tiền tố.

  1. Quy ước viết câu lệnh.

Mỗi câu lệnh riêng rẽ trên một dòng.

  1. Khối mã nguồn.

Sử dụng cặp dấu { } để ghi lại một khối mã nguồn. Mỗi dấu ngoặc nằm trên một dòng (Ngoại lệ, kiểu enum, tính chất gọn hoặc khởi tạo trị giá cho mảng có thể ko cần).

Trong các lệnh if, for, foreach, … nếu chỉ có một lệnh thì có thể ko cần ghi lại khối mã nguồn. 

  1. Thụt đầu dòng và cách khoảng

  • Viết cách vào một khoảng tab đối với các lệnh nằm trong khối lệnh { }.

  • Viết cách vào một khoảng tab đối với lệnh ngay sau if, else, while, for, foreach.

  • Viết cách một khoảng trắng xung quanh các toán tử 2 ngôi và 3 ngôi.

  • Viết cách một khoảng trắng sau dấu “,” và “;”.

  1. Chú thích.

Nên comment trên những đoạn code khó hiểu hoặc công dụng đặc trưng. Tiếng nói sử dụng để chú thích phải đồng bộ xuyên suốt chương trình. Chọn một trong hai tiếng nói: tiếng Việt Unicode có dấu hoặc tiếng Anh.

Quy định chú thích:

  • Chỉ sử dụng // và /// để chú thích. Ko dùng /* */.

  • Có chú thích trên đầu mỗi file source code mô tả chương trình, công dụng của chương trình, tác giả, v.v…

  • Khối xử lý dữ liệu: Có chú thích trên mỗi class, mỗi phương thức, mỗi tính chất của class mô tả công dụng, thông số, v.v…

  • Khối xử lý giao diện: Có chú thích mô tả công dụng trên mỗi phương thức ko phải event, hàm Main.

Các kiểu chú thích:

  • Chú thích đơn giản.

  • Đoạn code phức tạp.

  • Mô tả trong thân hàm.

  • Mô tả field.

  • Đoạn code được người ko phải tác giả sửa đổi.

  1. Tiếng nói sử dụng.

Xoành xoạch sử dụng kiểu dữ liệu C# thay vì kiểu dữ liệu .NET.

Coding convention Laravel

Laravel là một dự án mã nguồn mở và bất kỳ người nào cũng có thể đóng góp cho Laravel để cải thiện nó. Chúng tôi hoan nghênh những người đóng góp, bất kể trình độ kỹ năng, giới tính, chủng tộc, tôn giáo hoặc quốc tịch. Có một tập thể nhiều chủng loại, sôi động là một trong những trị giá mấu chốt của phạm vi!

Để khuyến khích sự hợp tác tích cực, Laravel hiện chỉ chấp nhận các yêu cầu chứ ko phải báo cáo lỗi. “Báo cáo lỗi” có thể được gửi dưới dạng một yêu cầu có chứa một bài rà soát đơn vị ko đạt. Ngoài ra, một bản trình diễn về lỗi trong ứng dụng Laravel có thể được gửi dưới dạng một yêu cầu tới kho lưu trữ Laravel chính . Một thử nghiệm đơn vị hoặc ứng dụng ko thành công hỗ trợ cho nhóm tăng trưởng “chứng cứ” rằng lỗi tồn tại và sau lúc nhóm tăng trưởng khắc phục lỗi, nó nhập vai trò như một chỉ báo đáng tin tưởng rằng lỗi vẫn được khắc phục.

Mã nguồn Laravel được quản lý trên Github và có các kho lưu trữ cho mỗi dự án Laravel:

  • Khung Laravel.

  • Ứng dụng Laravel.

  • Tài liệu Laravel.

  • Thu ngân Laravel.

  • Đặc phái viên Laravel.

  • Laravel Homestead.

  • Laravel Homestead Build Scripts.

  • Trang web Laravel.

  • Nghệ thuật Laravel.

Coding convention PHP

Các tiêu chuẩn mã hóa PHP này dành cho tập thể WordPress nói chung. Chúng là buộc phải đối với WordPress Core và chúng tôi khuyến khích bạn sử dụng chúng cho các chủ đề và plugin của mình.

Cũng xem Tiêu chuẩn tài liệu nội tuyến PHP  tại đây:

Mở và đóng thẻ PHP

Lúc nhúng các đoạn mã PHP nhiều dòng trong một khối HTML, các thẻ mở và đóng PHP phải nằm trên một dòng của chính chúng.

Đúng (Nhiều dòng):

1

2

3

4

5

6

7

8

9

10

11

12

13

14

function foo() {

?>

<div>

<?php

echo esc_html(

bar(

$baz,

$bat

)

);

?>

</div>

<?php

}

Đúng (Dòng đơn):

1

<input name=”<?php echo esc_attr( $name ); ?>” />

Ko đúng:

1

2

3

if ( $a === $b ) { ?>

<some html>

<?php }

Ko có thẻ PHP viết tắt

Quan trọng: Ko bao giờ sử dụng thẻ khởi đầu PHP viết tắt. Luôn sử dụng các thẻ PHP đầy đủ. Chuẩn xác:

1

2

<?php … ?>

<?php echo esc_html( $var ); ?>

Ko đúng:

1

2

<? … ?>

<?= esc_html( $var ) ?>

Quy ước đặt tên

Sử dụng các chữ cái thường trong tên biến, hành động / bộ lọc và hàm (ko bao giờ camelCase). Phân tích các từ qua dấu gạch dưới. Đừng viết tắt tên biến một cách ko cần thiết; để mã rõ ràng và tự ghi lại.

1

function some_name( $some_variable ) { […] }

Tên lớp nên sử dụng các từ viết hoa được phân tích bằng dấu gạch dưới. Mọi từ viết tắt đều phải là chữ hoa.

1

2

class Walker_Category extends Walker { […] }

class WP_HTTP { […] }

Các hằng số phải ở dạng chữ hoa với dấu gạch dưới cách trở các từ:

1

define( ‘DOING_AJAX’, true );

Các tệp phải được đặt tên mô tả bằng cách sử dụng các chữ cái thường. Dấu gạch nối nên cách trở các từ.

Tên tệp class phải dựa trên tên class có thêm chữ class – viết trước và dấu gạch dưới trong tên lớp được thay thế bằng dấu gạch ngang, ví dụ WP_Error: trở thành:

Tiêu chuẩn đặt tên tệp này dành cho tất cả các tệp hiện nay và mới có các lớp. Có một ngoại lệ đối với quy tắc này cho ba tệp kế thừa : class.wp-dependencies.php,. Các tệp đó được thêm vào trước , một dấu chấm sau lớp từ thay vì dấu gạch ngang. class.wp-scripts.phpclass.wp-styles.phpclass.

Các tệp chứa thẻ mẫu trong thư mục wp-includes nên được – template thêm vào cuối tên để dễ thấy.

Coding convention in C

Một tệp Coding convention in C bao gồm các phần không giống nhau nên được phân tích bằng một số dòng trống. Mặc dù ko có giới hạn độ dài tối đa cho các tệp nguồn, nhưng các tệp có hơn 1000 dòng sẽ rất kềnh càng để xử lý. Trình thay đổi có thể ko có đủ ko gian tạm thời để thay đổi tệp, quá trình biên dịch diễn ra chậm hơn, v.v. Nhiều hàng dấu hoa thị, ví dụ, hiển thị ít thông tin so với thời kì cần cuộn qua và ko được khuyến khích. Các dòng dài hơn 79 cột ko được xử lý tốt bởi tất cả các thiết bị đầu cuối và nên tránh nếu có thể. Các dòng quá dài do thụt lề sâu thường là một triệu chứng của mã có tổ chức kém. Dưới đây là các quy ước cần biết lúc viết Coding convention in C:

Quy ước đặt tên tệp

Tên tệp được tạo thành từ tên cơ sở, dấu chấm và hậu tố tùy chọn. Ký tự trước tiên của tên phải là một chữ cái và tất cả các ký tự (trừ dấu chấm) phải là chữ thường và số. Tên cơ sở phải có tám ký tự trở xuống và hậu tố phải có ba ký tự trở xuống (bốn, nếu bạn bao gồm dấu chấm). Các quy tắc này vận dụng cho cả tệp chương trình và tệp mặc định được chương trình sử dụng và tạo ra (ví dụ: “rogue.sav”).

Một số trình biên dịch và dụng cụ yêu cầu các quy ước hậu tố nhất mực cho tên của tệp [5]. Các hậu tố sau là buộc phải:

  • Tên tệp nguồn C phải kết thúc bằng.c.

  • Tên tệp nguồn của trình lắp ráp phải kết thúc bằng.s.

  • Các quy ước sau đây được tuân thủ rộng rãi:

    • Tên tệp nhân vật có thể vận chuyển lại kết thúc bằng.o.

    • Bao gồm các tên tệp tiêu đề kết thúc bằng .h. Một quy ước thay thế có thể thích hợp hơn trong môi trường đa tiếng nói là sử dụng hậu tố cho cả loại tiếng nói và .h(ví dụ: foo.c.h hoặc foo.ch).

    • Tên tệp nguồn yacc kết thúc bằng.y.

    • Tên tệp nguồn Lex kết thúc bằng.l.

  • C ++ có các quy ước hậu tố phụ thuộc vào trình biên dịch, bao gồm .c,, và . Vì nhiều mã C cũng là mã C ++ nên ko có giải pháp rõ ràng nào ở đây…c.cc.c.c.C

Ngoài ra, thông thường sử dụng Makefile(ko makefile) cho tệp điều khiển cho make (đối với các hệ thống hỗ trợ nó) và “README” để tóm tắt nội dung của thư mục hoặc cây thư mục.

File chương trình

Trật tự được đề xuất của các phần cho một tệp chương trình như sau:

  • Trước tiên trong tệp là đoạn mở đầu cho biết những gì có trong tệp đó. Mô tả về mục tiêu của các nhân vật trong tệp (cho dù chúng là hàm, khai báo hoặc khái niệm dữ liệu bên ngoài hoặc một cái gì đó khác) hữu ích hơn một danh sách tên nhân vật. Phần mở đầu có thể tùy ý chứa (các) tác giả, thông tin kiểm soát sửa đổi, tài liệu tham khảo,…

  • Bất kỳ tệp tiêu đề bao gồm phải là tiếp theo. Nếu bao gồm vì một lý do mập mờ, lý do nên được ghi chú. Trong hồ hết các trường hợp, hệ thống bao gồm các tệp như stdio.h nên được đưa vào trước lúc người dùng đưa vào tệp.

  • Tiếp theo là bất kỳ khái niệm và typedef nào vận dụng cho toàn thể tệp. Một trật tự thông thường là phải có macro “hằng số” trước, sau đó tới macro “hàm”, sau đó là typedefs và enums. 

  • Tiếp theo là khai báo dữ liệu tổng thể (bên ngoài), thường theo trật tự: externs, ko static global, static global. Nếu một tập trung các khái niệm vận dụng cho một phần dữ liệu tổng thể cụ thể (chẳng hạn như một từ flags), các khái niệm phải nằm ngay sau khai báo dữ liệu hoặc được nhúng trong các khai báo cấu trúc, được thụt vào để đặt các khái niệm sâu hơn một cấp so với từ khóa trước tiên của tuyên bố nhưng mà họ vận dụng. 

  • Các công dụng tới sau cuối và phải theo một trật tự có ý nghĩa nào đó. Giống như các công dụng nên xuất hiện cùng nhau. Phương pháp tiếp cận “theo chiều rộng” (các công dụng ở mức độ trừu tượng tương tự với nhau) được ưu tiên hơn so với phương pháp trước tiên theo chiều sâu (các công dụng được xác định càng sớm càng tốt trước hoặc sau cuộc gọi của chúng). Sự phán xét đáng cân nhắc được kêu gọi ở đây. Nếu xác định số lượng lớn các hàm tiện ích độc lập về cơ bản, hãy xem xét trật tự bảng chữ cái.

Trên đây là tổng hợp các thông tin liên quan tới coding convention là gì cùng tổng hợp các thông tin, quy định về các tiêu chuẩn quy ước mã hóa cụ thể trong từng tiếng nói lập trình. Kỳ vọng rằng qua bài viết này các bạn sẽ hiểu hơn về coding convention là gì cùng các quy tắc của coding convention.

Xem thêm: Tổng hợp thông tin về tính chất của cạnh tranh là gì

Thắc mắc –

[rule_{ruleNumber}]

}

Tên lớp nên sử dụng các từ viết hoa được phân tích bằng dấu gạch dưới. Mọi từ viết tắt đều phải là chữ hoa.

1

2

class Walker_Category extends Walker { […] }

class WP_HTTP { […] }

Các hằng số phải ở dạng chữ hoa với dấu gạch dưới cách trở các từ:

1

define( ‘DOING_AJAX’, true );

Các tệp phải được đặt tên mô tả bằng cách sử dụng các chữ cái thường. Dấu gạch nối nên cách trở các từ.

Tên tệp class phải dựa trên tên class có thêm chữ class – viết trước và dấu gạch dưới trong tên lớp được thay thế bằng dấu gạch ngang, ví dụ WP_Error: trở thành:

Tiêu chuẩn đặt tên tệp này dành cho tất cả các tệp hiện nay và mới có các lớp. Có một ngoại lệ đối với quy tắc này cho ba tệp kế thừa : class.wp-dependencies.php,. Các tệp đó được thêm vào trước , một dấu chấm sau lớp từ thay vì dấu gạch ngang. class.wp-scripts.phpclass.wp-styles.phpclass.

Các tệp chứa thẻ mẫu trong thư mục wp-includes nên được – template thêm vào cuối tên để dễ thấy.

Coding convention in C

Một tệp Coding convention in C bao gồm các phần không giống nhau nên được phân tích bằng một số dòng trống. Mặc dù ko có giới hạn độ dài tối đa cho các tệp nguồn, nhưng các tệp có hơn 1000 dòng sẽ rất kềnh càng để xử lý. Trình thay đổi có thể ko có đủ ko gian tạm thời để thay đổi tệp, quá trình biên dịch diễn ra chậm hơn, v.v. Nhiều hàng dấu hoa thị, ví dụ, hiển thị ít thông tin so với thời kì cần cuộn qua và ko được khuyến khích. Các dòng dài hơn 79 cột ko được xử lý tốt bởi tất cả các thiết bị đầu cuối và nên tránh nếu có thể. Các dòng quá dài do thụt lề sâu thường là một triệu chứng của mã có tổ chức kém. Dưới đây là các quy ước cần biết lúc viết Coding convention in C:

Quy ước đặt tên tệp

Tên tệp được tạo thành từ tên cơ sở, dấu chấm và hậu tố tùy chọn. Ký tự trước tiên của tên phải là một chữ cái và tất cả các ký tự (trừ dấu chấm) phải là chữ thường và số. Tên cơ sở phải có tám ký tự trở xuống và hậu tố phải có ba ký tự trở xuống (bốn, nếu bạn bao gồm dấu chấm). Các quy tắc này vận dụng cho cả tệp chương trình và tệp mặc định được chương trình sử dụng và tạo ra (ví dụ: “rogue.sav”).

Một số trình biên dịch và dụng cụ yêu cầu các quy ước hậu tố nhất mực cho tên của tệp [5]. Các hậu tố sau là buộc phải:

  • Tên tệp nguồn C phải kết thúc bằng.c.

  • Tên tệp nguồn của trình lắp ráp phải kết thúc bằng.s.

  • Các quy ước sau đây được tuân thủ rộng rãi:

    • Tên tệp nhân vật có thể vận chuyển lại kết thúc bằng.o.

    • Bao gồm các tên tệp tiêu đề kết thúc bằng .h. Một quy ước thay thế có thể thích hợp hơn trong môi trường đa tiếng nói là sử dụng hậu tố cho cả loại tiếng nói và .h(ví dụ: foo.c.h hoặc foo.ch).

    • Tên tệp nguồn yacc kết thúc bằng.y.

    • Tên tệp nguồn Lex kết thúc bằng.l.

  • C ++ có các quy ước hậu tố phụ thuộc vào trình biên dịch, bao gồm .c,, và . Vì nhiều mã C cũng là mã C ++ nên ko có giải pháp rõ ràng nào ở đây…c.cc.c.c.C

Ngoài ra, thông thường sử dụng Makefile(ko makefile) cho tệp điều khiển cho make (đối với các hệ thống hỗ trợ nó) và “README” để tóm tắt nội dung của thư mục hoặc cây thư mục.

File chương trình

Trật tự được đề xuất của các phần cho một tệp chương trình như sau:

  • Trước tiên trong tệp là đoạn mở đầu cho biết những gì có trong tệp đó. Mô tả về mục tiêu của các nhân vật trong tệp (cho dù chúng là hàm, khai báo hoặc khái niệm dữ liệu bên ngoài hoặc một cái gì đó khác) hữu ích hơn một danh sách tên nhân vật. Phần mở đầu có thể tùy ý chứa (các) tác giả, thông tin kiểm soát sửa đổi, tài liệu tham khảo,…

  • Bất kỳ tệp tiêu đề bao gồm phải là tiếp theo. Nếu bao gồm vì một lý do mập mờ, lý do nên được ghi chú. Trong hồ hết các trường hợp, hệ thống bao gồm các tệp như stdio.h nên được đưa vào trước lúc người dùng đưa vào tệp.

  • Tiếp theo là bất kỳ khái niệm và typedef nào vận dụng cho toàn thể tệp. Một trật tự thông thường là phải có macro “hằng số” trước, sau đó tới macro “hàm”, sau đó là typedefs và enums. 

  • Tiếp theo là khai báo dữ liệu tổng thể (bên ngoài), thường theo trật tự: externs, ko static global, static global. Nếu một tập trung các khái niệm vận dụng cho một phần dữ liệu tổng thể cụ thể (chẳng hạn như một từ flags), các khái niệm phải nằm ngay sau khai báo dữ liệu hoặc được nhúng trong các khai báo cấu trúc, được thụt vào để đặt các khái niệm sâu hơn một cấp so với từ khóa trước tiên của tuyên bố nhưng mà họ vận dụng. 

  • Các công dụng tới sau cuối và phải theo một trật tự có ý nghĩa nào đó. Giống như các công dụng nên xuất hiện cùng nhau. Phương pháp tiếp cận “theo chiều rộng” (các công dụng ở mức độ trừu tượng tương tự với nhau) được ưu tiên hơn so với phương pháp trước tiên theo chiều sâu (các công dụng được xác định càng sớm càng tốt trước hoặc sau cuộc gọi của chúng). Sự phán xét đáng cân nhắc được kêu gọi ở đây. Nếu xác định số lượng lớn các hàm tiện ích độc lập về cơ bản, hãy xem xét trật tự bảng chữ cái.

Trên đây là tổng hợp các thông tin liên quan tới coding convention là gì cùng tổng hợp các thông tin, quy định về các tiêu chuẩn quy ước mã hóa cụ thể trong từng tiếng nói lập trình. Kỳ vọng rằng qua bài viết này các bạn sẽ hiểu hơn về coding convention là gì cùng các quy tắc của coding convention.

Xem thêm: Tổng hợp thông tin về tính chất của cạnh tranh là gì

Thắc mắc –

[rule_{ruleNumber}]

#Coding #convention #là #gì #Tìm #hiểu #về #coding #convention #java

Bạn thấy bài viết Coding convention là gì? Tìm hiểu về coding convention java có khắc phục đươc vấn đề bạn tìm hiểu ko?, nếu  ko hãy comment góp ý thêm về Coding convention là gì? Tìm hiểu về coding convention java bên dưới để thpttranhungdao.edu.vn có thể thay đổi & cải thiện nội dung tốt hơn cho độc giả nhé! Cám ơn bạn đã ghé thăm Website Trường THPT Trần Hưng Đạo

Nhớ để nguồn bài viết này: Coding convention là gì? Tìm hiểu về coding convention java của website thpttranhungdao.edu.vn

Phân mục: Là gì?
#Coding #convention #là #gì #Tìm #hiểu #về #coding #convention #java

mtoplist