Báo cáo dòng đơn & Thực tiễn tốt

Gần đây tôi đã có được một thói quen mà nhiều người trong số các bạn có thể cau mày, nhưng cuối cùng, điều đó giúp tôi theo dõi cấu trúc mã toàn cầu thay vì cấu trúc của một phương pháp lặp đi lặp lại (đôi khi): nhóm một số các câu lệnh trong một dòng duy nhất, như thế này:

textBox1.Text = "Something!"; textBox2.Text = "Another thing!"; textBox3.Text = "Yet another thing!";

như trái ngược với

textBox1.Text = "Something!";
textBox2.Text = "Another thing!";
textBox3.Text = "Yet another thing!";

Tôi sử dụng để làm điều đó cho các nhiệm vụ lặp đi lặp lại để duy trì mã "vẻ đẹp" tổng thể và để giúp tôi theo dõi cấu trúc chương trình một cách dễ dàng, nhưng tôi thừa nhận nó có thể không phải là một thực hành tốt. Tôi thực sự sử dụng nó rất nhiều, vì vậy tôi muốn biết suy nghĩ của bạn về điều này là gì. Ngoài ra, bạn có nghĩ rằng bất cứ ai sẽ phải duy trì mã của tôi đều gặp vấn đề với cách tiếp cận này không?

Tôi thực sự nghĩ rằng khả năng đọc sẽ ảnh hưởng rất lớn cho cả bạn và chắc chắn bất kỳ ai khác đang đọc mã. Tất cả đều có ý nghĩa khi bạn viết nó lần đầu tiên vì nó chủ động trong tâm trí bạn. Sẽ khác khi bạn quét mã để xem biến và chức năng là gì ... bạn đang tự hủy khả năng quét mã của chính mình. Đó là một khổng lồ không có-không, và xa hơn nữa xấu nếu bất cứ ai khác đã từng có để đọc mã của bạn.

Ngoài ra, hãy suy nghĩ về cách bạn đọc mã. Nó luôn luôn từ trên xuống, cuộn xuống. Phương pháp của bạn không phù hợp với điều này và thậm chí còn giới thiệu một trong những vấn đề xấu nhất có thể xảy ra trong việc đọc mã; cuộn theo chiều ngang . Đừng bao giờ đánh giá thấp mức độ khó mà có thể làm cho việc đọc mã. Bạn không bao giờ cuộn theo chiều ngang, bạn không bao giờ khiến mọi người cuộn theo chiều ngang, trong hầu hết mọi bối cảnh, điều đó cực kỳ không tự nhiên.

Ngoài ra, nếu vấn đề của bạn là nhập mã lặp đi lặp lại ... đừng quên Ctrl-C. Từ mã ví dụ của bạn, có thể hiệu quả hơn khi nhập tất cả bằng tay, nhưng nếu bạn phải sao chép một loạt các dòng nhiều lần thì có vẻ như việc sao chép dòng một cộng với một dòng mới sẽ hiệu quả hơn x lần và thực hiện các thay đổi, ít có khả năng mắc lỗi đánh máy.

Ồ, và lỗi chính tả! Làm hại tính dễ đọc của mã của bạn như thế có thể khiến nó trở thành cơn ác mộng khi tìm ra khai báo nào trong số 50 khai báo biến bạn đặt sai. Bây giờ hầu hết các trình biên dịch đều đưa ra lỗi ở số hàng VÀ số cột, nhưng việc tìm lỗi tại một hàng dễ dàng hơn nhiều so với tìm cột.

Một tuyên bố trên mỗi dòng cũng giúp dễ dàng hơn để xem những gì đã thay đổi trong một khác biệt bên cạnh.

Trong khi ví dụ không cho thấy điều này, có một vấn đề khác với việc nhóm nhiều câu lệnh trên một dòng. Điều gì sẽ xảy ra nếu một trong năm câu lệnh bạn có trên một dòng ném một ngoại lệ?

Theo dõi ngăn xếp của bạn sẽ nói "EBazaki tại dòng N" ... và bây giờ bạn không biết trong số năm câu lệnh đó đã ném ngoại lệ.

(Điều tương tự xảy ra với một tuyên bố quá dài của bất kỳ loại nào.)

One-statement-per-line là một kiểu mã hóa được sử dụng rộng rãi. Do đó, hầu hết các nhà phát triển nhìn vào mã của bạn trong tương lai có thể sẽ nhăn nhó khi họ thấy nhiều câu lệnh trên mỗi dòng. Khi bạn đã từng nhìn thấy một cái gì đó một cách, nó có thể mất phương hướng để nhìn thấy nó theo một cách khác.

Vì lý do này, tôi khuyên chống lại nó, ngoại trừ trong những trường hợp hiếm hoi.

Lần cuối cùng tôi đã làm điều này 25 năm trước bằng cách sử dụng các ngôn ngữ được giải thích trên các micrô nhỏ chạy với tốc độ xung nhịp thấp, trong đó mọi khoảng trống hoặc vận chuyển trở lại bị loại bỏ đều làm tăng hiệu suất.

Bây giờ tôi nhăn nhó khi nghĩ về nó (mặc dù nó đã được thực hiện vì một lý do tốt).

Thật không may, mã như vậy rất khó đọc, và do đó khó duy trì.

Về mặt cú pháp, thực sự không có gì sai với nó. Nó thực sự phụ thuộc vào phong cách mã hóa của nhóm của bạn.

Vì hầu hết các mã tôi đã thấy (bao gồm cả mã nằm trong các tiêu đề c ++ tiêu chuẩn) được thực hiện theo cách này, tôi sẽ thực hiện theo phương pháp đầu tiên của bạn.

textBox1.Text = "Something!";
textBox2.Text = "Another thing!";
textBox3.Text = "Yet another thing!";

Đây thực sự là phong cách mã hóa bất thường.

Tôi sẽ khuyên bạn nên sử dụng các dòng trống để phân định các phần logic của mã thay thế.

Đi quá xa về bên phải có thể tạo ra nhiều vấn đề như nhiều dòng.

Tôi đã phải đối phó với một số báo cáo sql với hàng chục lĩnh vực. Thông thường, tôi đặt một dòng trên mỗi dòng, nhưng trong một vài lần, tôi đã hợp nhất 3 hoặc 4 thành một hàng. Đây có vẻ là một ý tưởng tốt trong quá trình phát triển khi bạn phải cuộn lên xuống nhiều lần.

Tôi rất tiếc khi quay lại mã này. Có thêm hàng dường như không tạo ra nhiều vấn đề nên tôi thường dọn dẹp.

Ngoài ra, bạn có nghĩ rằng bất cứ ai sẽ phải duy trì mã của tôi đều gặp vấn đề với cách tiếp cận này không?

Sau khi đặt tay lên đầu trong một phút, anh ta sẽ sử dụng các chức năng IDE Regex yêu thích của mình để tự động tách tất cả các mã không thể đọc thành một câu lệnh trên mỗi dòng.

Chỉ cần nhìn nhanh vào ví dụ bạn đã trình bày là đủ để hiểu cách tiếp cận thứ hai dễ đọc hơn bao nhiêu.

Việc theo dõi dòng trang dọc sẽ dễ dàng hơn nhiều mà không cần phải di chuyển theo chiều ngang mãi mãi.

Nhìn vào ví dụ của bạn: bạn biết ngay mã là tất cả về thuộc Texttính của các textBoxđối tượng khác nhau và chúng chứa chuỗi dưới dạng giá trị. Khá đơn giản.

Cá nhân tôi sẽ không sử dụng một phong cách như vậy. Tóm tắt

Ưu

• Ít dòng mã hơn để cuộn qua
• có thể được sử dụng để mã nhóm ngữ nghĩa để diễn đạt: "rất nhiều công cụ chuyển nhượng". NHƯNG bạn luôn có thể cấu trúc lại một khối như vậy thành một hàm nếu nó làm phiền bạn quá nhiều.

Nhược điểm

• khó đọc, thường dễ đọc mã theo chiều ngang (đọc lướt, không chuyển động mắt, ...)
• khác biệt dễ dàng trở thành một cơn ác mộng, bao gồm cả sáp nhập
• khó thay đổi hơn (sao chép và dán, bình luận, ...)
• gỡ lỗi có thể là một vấn đề trong nhiều IDE khi chúng hoạt động trên các dòng thay vì các biểu thức riêng lẻ.