Chuẩn mã hóa và chiều dài dòng

Question

Mỗi chuẩn mã hóa mà tôi từng thấy đều có giới hạn được đề nghị hoặc tuyệt đối về số ký tự trong một dòng. Có nhiều cách khác nhau để làm việc trong giới hạn này, nhưng tôi đã không thấy bất kỳ hướng dẫn cụ thể nào về vấn đề này.

Rõ ràng, nếu có thể, đừng viết các dòng quá dài.

Nhưng nếu điều đó không thực tế thì sao? Các đường dài nên được xử lý như thế nào?

Dưới đây là một vài ví dụ

if ($Stmt = $Mysqli->prepare("SELECT color, pattern, size, 
           manufacturer, mfgSku, storeLocation, 
           aisle, status 
           FROM tblItems WHERE ourSku = ?")) { 

hoặc

$flavors = array ('chocolate', 'strawberry', 'vanilla', 'cookie dough', 
        'chocolate chip', 'mint chocolate chip', 'rocky road', 
        'peach', 'fudge brownie', 'coffee', 'mocha chip'); 

hoặc

$Stmt->bind_result($this->_firstName, 
        $this->_lastName, 
        $this->_BillToAddress->address1, 
        $this->_BillToAddress->address2, 
        $this->_BillToAddress->city, 
        $this->_BillToAddress->state, 
        $this->_BillToAddress->zip, 
        $this->_BillToAddress->country, 
        $this->_email, 
        $this->_status, 
        $this->_primaryPhone, 
        $this->_mobilePhone); 

Trong mỗi một trong các ví dụ, các indenting mã dài là khác nhau. Có cách nào tốt hơn hoặc nhiều hơn "tiêu chuẩn" để làm việc này không? Nếu các đường thừa luôn bị thụt vào theo cùng một cách. Hay điều này có được không?

Answer 1

Có một mẫu bạn có thể thấy trong mỗi ví dụ - chúng được thụt vào tham số đầu tiên của hàm. Đây là một tiêu chuẩn tốt để làm theo khi nó chuyển đổi dữ liệu từ ngang sang dọc và các cột cho phép đọc dễ dàng.

Đối với các vấn đề về độ dài dòng khác, chẳng hạn như tính toán dài, phương pháp ưu tiên là chia nhỏ. Tính toán ngày tháng julian, hoặc phục sinh được thực hiện trong một vài bước thay vì một phép tính dài.

-Adam

Answer 2

Tôi không biết tiêu chuẩn nào, vì nó sẽ được khó khăn để nói. Đối với những người trong chúng ta trên màn hình lớn hơn, chúng ta có thể xem mã ngang hơn những người khác trên màn hình nhỏ hơn. Tôi thường cố gắng xây dựng chuỗi dài theo tuần tự thông qua. = (PHP) khi cần thiết và mã của bạn đã chứng minh rằng tôi chia các mảng dài tùy ý thành các dòng mới tùy thuộc vào số ký tự tồn tại trong dòng cụ thể đó.

Answer 3

Tôi không nghĩ ai nên cố tình có đường dài nhưng, có nguy cơ vi phạm nhiều, tôi đề nghị độ dài dòng thực sự không còn quan trọng nữa.

Vim và emacs xử lý các dòng dài khá tốt và chúng được cài đặt trên hầu hết mọi hộp Unix. Trên Windows, bạn hầu như luôn ở trong trình soạn thảo văn bản GUI. Tôi nghĩ phong cách $Stmt->bind_result của bạn là dễ đọc nhất, nhưng nếu bạn chỉ cần tải một loạt thông tin chủ yếu là tĩnh trong một câu lệnh, tôi không có vấn đề gì với dòng 1000 ký tự.

Answer 4

Bối cảnh quyết định cái nào bạn chọn. Cuối cùng bạn đang viết mã để được đọc bởi một con người. Nếu thụt lề một khối mã khác nhau sẽ làm cho nó dễ đọc hơn sau đó làm điều đó.

Answer 5

Số cửa 3. Nếu bạn không thể làm điều đó trên một dòng, hãy thực hiện nó trên một dòng cho mỗi mục, bất cứ thứ gì khác làm xáo trộn các mục sau hàng đầu tiên trên đường dây và thật kinh khủng để đọc. Các vấn đề thụt đầu dòng nhất quán cũng vậy.

Fwiw, tôi nghĩ rằng đây là chiếc mũ cũ trong một ngày và tuổi mà hầu hết các lập trình viên nên có màn hình kép ở độ phân giải cao. Ví dụ đầu tiên trông giống như nó có thể là một dòng khá hạnh phúc.

Answer 6

Điều này thực sự khá chủ quan, giống như vị trí của dấu ngoặc và các kiểu mã hóa khác.Điều chính không phải là quá nhiều kiểu mà bạn chọn, nhưng bạn chọn phong cách và bạn gắn bó với nó trong suốt dự án.

Đối với cá nhân tôi, đến từ một nền Python, tôi sử dụng một đường dài của 79 và một phong cách

$flavors = array ('chocolate', 'strawberry', 'vanilla', 'cookie dough', 
        'chocolate chip', 'mint chocolate chip', 'rocky road', 
        'peach', 'fudge brownie', 'coffee', 'mocha chip'); 

.

Nhưng như tôi nói, theo ý kiến ​​của tôi, điều quan trọng hơn là phải có một phong cách, chứ không phải lo lắng về cái nào.

Answer 7

Trong văn xuôi, các dòng dài hơn 80 hoặc lâu hơn đã được chứng minh là khó đọc hơn. (Xem trang 13 của LaTeX Memoir lớp documentation.) Code Complete (phần 18.5, trang 425 của phiên bản của tôi) của cũng tham chiếu giới hạn 80 ký tự với điều kiện này:

Với màn hình lớn hơn, kiểu chữ hẹp, laser máy in và chế độ ngang, các đối số cho giới hạn 80 ký tự không hấp dẫn như chúng đã sử dụng với tôi. Một dòng dài 90 ký tự thường có thể đọc được nhiều hơn so với một dòng được chia thành hai chỉ để tránh tràn qua cột 80. Với công nghệ hiện đại, đôi khi nó có thể vượt quá 80 cột.

tôi sẽ thụt SQL trong ví dụ đầu tiên của bạn tách biệt với phần còn lại của các mã:

if ($Stmt = $Mysqli->prepare(
      "SELECT color, pattern, size, 
        manufacturer, mfgSku, storeLocation, 
        aisle, status 
      FROM tblItems 
      WHERE ourSku = ?")) { 

Ví dụ thứ hai có thể là tốt hơn nếu nó được nạp vào một tập tin cấu hình hoặc bàn.

Thứ ba là tốt, nhưng bạn có thể thắt chặt nó lên một chút với:

$Stmt->bind_result( 
    $this->_firstName, 
    $this->_lastName, 
    $this->_BillToAddress->address1, 
    $this->_BillToAddress->address2, 
    $this->_BillToAddress->city, 
    $this->_BillToAddress->state, 
    $this->_BillToAddress->zip, 
    $this->_BillToAddress->country, 
    $this->_email, 
    $this->_status, 
    $this->_primaryPhone, 
    $this->_mobilePhone 
); 

Answer 8

Tôi không quan tâm lựa chọn 3 quá nhiều (1 mục trên mỗi dòng). Ngoài ra, cá nhân, tôi luôn luôn sử dụng wordwrapping, do đó, có mã trên một dòng không làm phiền tôi cả. Tuy nhiên, trong ví dụ thứ hai của bạn, với wordwrapping trên, mà có thể trông giống như một mớ hỗn độn cho các lập trình viên sử dụng wordwrapping. Có lẽ tôi thuộc một nhóm nhỏ hơn, những người không quan tâm đến những lời thoại dài.

Answer 9

Các thực hành tốt nhất thường xuất phát từ mục đích đằng sau những hạn chế dòng dài thân:

• Tăng khả năng tương tác (giữa các lập trình viên, chỉnh sửa phần mềm, vv)
• Để tăng khả năng đọc và hiểu
• Để tăng sự hưởng thụ và tốc độ phát triển
• Để tăng doanh thu và lợi nhuận

Vì vậy, các lựa chọn của bạn, chẳng hạn như sắp xếp tất cả các tham số stmt, là tốt nếu chúng đóng góp cả cho hiểu tương lai của bạn và của những người khác trong nhóm của bạn.

Hy vọng điều này sẽ giúp;) -M

Answer 10

Sở thích cá nhân của tôi là như sau;

 
$Stmt->bind_result(
    $this->_firstName, 
    $this->_lastName, 
    $this->_BillToAddress->address1, 
    $this->_BillToAddress->address2, 
    $this->_BillToAddress->city, 
    $this->_BillToAddress->state, 
    $this->_BillToAddress->zip, 
    $this->_BillToAddress->country, 
    $this->_email, 
    $this->_status, 
    $this->_primaryPhone, 
    $this->_mobilePhone 
); 

Bằng cách đó, dấu đóng và dấu chấm phẩy là cùng một thụt lề như lệnh gọi mở. Không phải tất cả các ngôn ngữ đều hỗ trợ các tham số trên một dòng khác để gọi phương thức ...

Answer 11

Nếu bạn đang gói nhiều hơn hai mục, tôi thích một dòng mới cho mỗi mục như trong ví dụ thứ ba của bạn. Các công cụ kiểm soát nguồn tự động dễ dàng hơn để hợp nhất các chỉnh sửa từ những người khác nếu chỉ có một mục trên mỗi dòng.

Answer 12

Một phong cách thụt lề bất thường mà tôi thấy mình nới lỏng khi thực hiện rất nhiều công việc SQL;

INSERT INTO someTable 
(
    id, 
    name, 
    age, 
    address1, 
    address2, 
) 
VALUES 
(
    2, 
    'Bob' 
    25, 
    '12 Fake Street', 
    'The Moon' 
) 

Tôi thực sự thấy dễ đọc hơn bất kỳ bố cục nào khác cho danh sách tham số dài.

Answer 13

Làm theo tiêu chuẩn được mã xung quanh sử dụng. Không tạo của riêng bạn "tiêu chuẩn' dù có bao nhiêu 'tốt hơn'.

Answer 14

Một số thông tin hữu ích ở đây http://framework.zend.com/manual/en/coding-standard.coding-style.html