Những thứ ngay lập tức rung chuông báo động khi nhìn vào mã? [đóng cửa]

Tôi đã tham dự một sự kiện thủ công phần mềm vài tuần trước và một trong những ý kiến ​​được đưa ra là "Tôi chắc chắn tất cả chúng ta đều nhận ra mã xấu khi nhìn thấy nó" và mọi người gật đầu lúng túng mà không cần thảo luận thêm.

Điều này luôn làm tôi lo lắng vì có sự thật rằng mọi người đều nghĩ rằng họ là một tài xế trên trung bình. Mặc dù tôi nghĩ rằng tôi có thể nhận ra mã xấu Tôi muốn tìm hiểu thêm về những gì người khác cho là mã có mùi vì nó hiếm khi được thảo luận chi tiết trên blog của mọi người và chỉ trong một số ít sách. Đặc biệt tôi nghĩ sẽ rất thú vị khi nghe về bất cứ thứ gì có mùi mã trong một ngôn ngữ chứ không phải ngôn ngữ khác.

Tôi sẽ bắt đầu với một điều dễ dàng:

Mã trong kiểm soát nguồn có tỷ lệ cao của mã nhận xét - tại sao nó lại ở đó? nó có nghĩa là bị xóa? nó là một nửa hoàn thành công việc? có lẽ nó không nên được bình luận và chỉ được thực hiện khi ai đó đang thử nghiệm cái gì đó? Cá nhân tôi thấy loại điều này thực sự gây phiền nhiễu ngay cả khi nó chỉ là dòng lẻ ở đây và đó, nhưng khi bạn thấy các khối lớn xen kẽ với phần còn lại của mã thì hoàn toàn không thể chấp nhận được. Nó cũng thường là một dấu hiệu cho thấy phần còn lại của mã có khả năng cũng có chất lượng đáng ngờ.

/* Fuck this error */

Thường được tìm thấy bên trong một try..catchkhối vô nghĩa , nó có xu hướng thu hút sự chú ý của tôi. Cũng gần như là /* Not sure what this does, but removing it breaks the build */.

Một vài điều nữa:

• Nhiều ifcâu lệnh phức tạp lồng nhau
• Các khối thử bắt được sử dụng để xác định luồng logic một cách thường xuyên
• Chức năng với tên chung process, data, change, rework,modify
• Sáu hoặc bảy kiểu giằng khác nhau trong 100 dòng

Một cái tôi vừa tìm thấy:

/* Stupid database */
$conn = null;
while(!$conn) {
    $conn = mysql_connect("localhost", "root", "[pass removed]");
}
/* Finally! */
echo("Connected successfully.");

Đúng, bởi vì phải vũ phu buộc các kết nối MySQL của bạn là cách làm đúng đắn. Hóa ra cơ sở dữ liệu đã có vấn đề với số lượng kết nối để họ liên tục hết thời gian. Thay vì gỡ lỗi này, họ chỉ cần cố gắng lặp đi lặp lại cho đến khi nó hoạt động.

Cờ đỏ lớn đối với tôi là các khối mã trùng lặp, bởi vì nó cho thấy rằng người đó không hiểu các nguyên tắc lập trình cơ bản hoặc quá sợ hãi để thực hiện các thay đổi phù hợp cho cơ sở mã hiện có.

Tôi cũng từng coi việc thiếu bình luận là một lá cờ đỏ, nhưng gần đây đã làm việc với rất nhiều mã rất tốt mà không có bình luận nào tôi đã giảm bớt về điều đó.

Mã cố gắng thể hiện mức độ thông minh của lập trình viên, mặc dù thực tế là nó không có giá trị thực:

x ^= y ^= x ^= y;

• 20.000 (cường điệu) chức năng dòng. Bất kỳ chức năng nào có nhiều hơn một vài màn hình đều cần bao thanh toán lại.

• Dọc theo cùng một dòng, các tập tin lớp dường như đi mãi mãi. Có lẽ có một vài khái niệm có thể được trừu tượng hóa thành các lớp sẽ làm rõ mục đích và chức năng của lớp gốc và có lẽ nó đang được sử dụng, trừ khi chúng là tất cả các phương thức bên trong.

• các biến không mô tả, không tầm thường hoặc quá nhiều biến không mô tả tầm thường. Những điều này làm cho suy luận những gì đang thực sự xảy ra một câu đố.

{ Let it Leak, people have good enough computers to cope these days }

Điều tồi tệ hơn là từ một thư viện thương mại!

Nhận xét dài dòng đến mức nếu có trình biên dịch tiếng Anh, nó sẽ biên dịch và chạy hoàn hảo, nhưng không mô tả bất cứ điều gì mà mã không có.

//Copy the value of y to temp.
temp = y;
//Copy the value of x to y.
y = x;
//Copy the value of temp to x.
x = temp;

Ngoài ra, các nhận xét về mã có thể đã được loại bỏ với mã đã tuân thủ một số nguyên tắc cơ bản:

//Set the age of the user to 13.
a = 13;

Mã tạo cảnh báo khi biên dịch.

Các hàm có số trong tên thay vì có tên mô tả , như:

void doSomething()
{
}

void doSomething2()
{
}

Xin vui lòng, làm cho tên hàm có ý nghĩa gì đó! Nếu doS Something và doS Something2 làm những việc tương tự, hãy sử dụng tên hàm để phân biệt sự khác biệt. Nếu doS Something2 là một sự đột phá về chức năng từ doS Something, hãy đặt tên cho chức năng của nó.

Số ma thuật hoặc Chuỗi ma thuật.

   if (accountBalance>200) { sendInvoice(...); }

   salesPrice *= 0.9;   //apply discount    

   if (invoiceStatus=="Overdue") { reportToCreditAgency(); }

• Có thể không phải là tồi tệ nhất nhưng rõ ràng cho thấy mức độ người thực hiện:

  if(something == true) 

• Nếu một ngôn ngữ có cấu trúc vòng lặp for hoặc iterator, thì việc sử dụng vòng lặp while cũng thể hiện mức độ hiểu biết về ngôn ngữ của người triển khai:

  count = 0; 
  while(count < items.size()){
     do stuff
     count ++; 
  }
  
  for(i = 0; i < items.size(); i++){
    do stuff 
  }
  //Sure this is not terrible but use the language the way it was meant to be used.

• Chính tả / ngữ pháp kém trong tài liệu / nhận xét ăn vào của tôi gần như bằng chính mã. Lý do cho điều này là vì mã có nghĩa là cho con người đọc và máy móc để chạy. Đây là lý do tại sao chúng tôi sử dụng các ngôn ngữ cấp cao, nếu tài liệu của bạn khó vượt qua nó khiến tôi hình thành ý kiến ​​tiêu cực về codebase mà không cần nhìn vào nó.

Cái tôi nhận thấy ngay lập tức là tần số của các khối mã được lồng sâu (nếu là, trong khi, v.v.). Nếu mã thường xuyên đi sâu hơn hai hoặc ba cấp, đó là dấu hiệu của vấn đề thiết kế / logic. Và nếu nó đi sâu như 8 tổ, tốt hơn hết là một lý do chính đáng để nó không bị phá vỡ.

Khi chấm điểm chương trình của học sinh, đôi khi tôi có thể nói trong một khoảnh khắc kiểu "nháy mắt". Đây là những manh mối tức thì:

• Định dạng kém hoặc không nhất quán
• Nhiều hơn hai dòng trống liên tiếp
• Quy ước đặt tên không chuẩn hoặc không nhất quán
• Mã lặp lại, lặp lại nguyên văn càng nhiều, cảnh báo càng mạnh
• Điều gì phải là một đoạn mã đơn giản là quá phức tạp (ví dụ: kiểm tra các đối số được truyền đến chính theo cách phức tạp)

Hiếm khi những ấn tượng đầu tiên của tôi không chính xác, và những tiếng chuông cảnh báo này đúng khoảng 95% . Đối với một ngoại lệ, một sinh viên mới sử dụng ngôn ngữ đã sử dụng một phong cách từ một ngôn ngữ lập trình khác. Đi sâu vào và đọc lại phong cách của họ trong thành ngữ của ngôn ngữ khác đã gỡ bỏ tiếng chuông báo thức cho tôi, và sau đó sinh viên đã nhận được tín dụng đầy đủ. Nhưng ngoại lệ như vậy là rất hiếm.

Khi xem xét mã nâng cao hơn, đây là những cảnh báo khác của tôi:

• Sự hiện diện của nhiều lớp Java chỉ là "cấu trúc" để chứa dữ liệu. Không thành vấn đề nếu các trường là công khai hoặc riêng tư và sử dụng getters / setters, nó vẫn không phải là một phần của một thiết kế chu đáo.
• Các lớp có tên kém, chẳng hạn như chỉ là một không gian tên và không có sự gắn kết thực sự trong mã
• Tham chiếu đến các mẫu thiết kế thậm chí không được sử dụng trong mã
• Xử lý ngoại lệ trống mà không giải thích
• Khi tôi kéo mã lên trong Eclipse, hàng trăm "cảnh báo" màu vàng sẽ mã dòng, chủ yếu là do nhập hoặc các biến không được sử dụng

Về phong cách, tôi thường không muốn thấy:

• Javadoc bình luận chỉ lặp lại mã

Đây chỉ là manh mối cho mã xấu. Đôi khi những gì có vẻ như mã xấu thực sự không phải là vì bạn không biết ý định của lập trình viên. Ví dụ, có thể có một lý do chính đáng rằng một cái gì đó có vẻ quá phức tạp - có thể có một sự xem xét khác khi chơi.

Yêu thích cá nhân / peeve vật nuôi: IDE tạo tên được nhận. Nếu TextBox1 là một biến số quan trọng và quan trọng trong hệ thống của bạn, thì bạn đã có một điều nữa sắp tới là xem xét mã.

Các biến hoàn toàn không được sử dụng , đặc biệt là khi biến có tên tương tự với tên biến được sử dụng.

Rất nhiều người đã đề cập:

//TODO: [something not implemented]

Trong khi tôi ước điều đó được thực hiện, ít nhất họ đã ghi chú lại. Những gì tôi nghĩ là tồi tệ hơn là:

//TODO: [something that is already implemented]

Todo là vô giá trị và khó hiểu nếu bạn không bao giờ bận tâm để loại bỏ chúng!

Một phương pháp đòi hỏi tôi phải cuộn xuống để đọc tất cả.

Các kết hợp trong tên phương thức:

public void addEmployeeAndUpdatePayrate(...) 


public int getSalaryOrHourlyPay(int Employee) ....

Làm rõ: Lý do chuông này báo động là vì nó chỉ ra phương pháp có khả năng vi phạm nguyên tắc trách nhiệm duy nhất .

Liên kết rõ ràng mã nguồn GPL'd thành một chương trình nguồn đóng, thương mại.

Nó không chỉ tạo ra một vấn đề pháp lý ngay lập tức, mà theo kinh nghiệm của tôi, nó thường chỉ ra sự bất cẩn hoặc không quan tâm được phản ánh ở nơi khác trong mã.

Ngôn ngữ bất khả tri:

• TODO: not implemented
• int function(...) { return -1; } (giống như "không được thực hiện")
• Ném một ngoại lệ cho một lý do không đặc biệt.
• Lạm dụng hoặc sử dụng không phù hợp của 0, -1hoặc nullgiá trị trả lại là ngoại lệ.
• Khẳng định mà không có một bình luận thuyết phục nói tại sao nó không bao giờ nên thất bại.

Ngôn ngữ cụ thể (C ++):

• Macro C ++ viết thường.
• Biến C ++ tĩnh hoặc toàn cầu.
• Các biến không được khởi tạo hoặc không sử dụng.
• Bất kỳ array newđiều đó rõ ràng là không an toàn RAII.
• Bất kỳ việc sử dụng mảng hoặc con trỏ rõ ràng là không an toàn. Điều này bao gồm printf.
• Bất kỳ việc sử dụng phần chưa khởi tạo của một mảng.

Microsoft C ++ cụ thể:

• Bất kỳ tên định danh nào va chạm với macro đã được xác định bởi bất kỳ tệp tiêu đề SDK nào của Microsoft.
• Nói chung, bất kỳ việc sử dụng API Win32 là một nguồn chuông báo động lớn. Luôn mở MSDN và tra cứu các định nghĩa giá trị đối số / trả về bất cứ khi nào nghi ngờ. (Đã chỉnh sửa)

C ++ / OOP cụ thể:

• Kế thừa thực hiện (lớp cụ thể) trong đó lớp cha có cả phương thức ảo và không ảo, không có sự phân biệt khái niệm rõ ràng rõ ràng giữa những gì nên / không nên là ảo.

Phong cách thụt đầu dòng kỳ lạ.

Có một vài phong cách rất phổ biến, và mọi người sẽ đưa cuộc tranh luận đó xuống mồ. Nhưng đôi khi tôi thấy ai đó sử dụng một kiểu thụt đầu dòng thực sự hiếm, hoặc thậm chí là trồng tại nhà. Đây là một dấu hiệu cho thấy họ có thể đã không được mã hóa với bất kỳ ai khác ngoài chính họ.

Sử dụng nhiều khối văn bản thay vì enum hoặc các biến được xác định toàn cầu.

Không tốt:

if (itemType == "Student") { ... }

Tốt hơn:

private enum itemTypeEnum {
  Student,
  Teacher
}
if (itemType == itemTypeEnum.Student.ToString()) { ... }

Tốt:

private itemTypeEnum itemType;
...
if (itemType == itemTypeEnum.Student) { ... }

Nhập tham số yếu hoặc trả về giá trị trên các phương thức.

public DataTable GetEmployees() {...}

public DateTime getHireDate(DataTable EmployeeInfo) {...}

public void FireEmployee(Object EmployeeObjectOrEmployeeID) {...}

• Nhiều toán tử ternary nối với nhau, vì vậy thay vì giống một if...elsekhối, nó trở thành một if...else if...[...]...elsekhối
• Tên biến dài không có dấu gạch dưới hoặc camelCasing. Ví dụ từ một số mã tôi đã kéo lên:$lesseeloginaccountservice
• Hàng trăm dòng mã trong một tệp, có rất ít hoặc không có nhận xét và mã này rất không rõ ràng
• ifBáo cáo quá phức tạp . Ví dụ từ mã: if (!($lessee_obj instanceof Lessee && $lessee_obj != NULL))mà tôi đã nhai xuốngif ($lessee_obj == null)

Mùi mã: không tuân theo các thực hành tốt nhất

Điều này luôn làm tôi lo lắng vì có sự thật rằng mọi người đều nghĩ rằng họ là một tài xế trên trung bình.

Đây là một tin tức chớp nhoáng cho bạn: 50% dân số thế giới dưới mức thông minh trung bình. Ok, vì vậy một số người sẽ có trí thông minh chính xác trung bình, nhưng chúng ta đừng kén chọn. Ngoài ra, một trong những tác động phụ của sự ngu ngốc là bạn không thể nhận ra sự ngu ngốc của chính mình! Mọi thứ sẽ không tốt nếu bạn kết hợp những tuyên bố này.

Những thứ ngay lập tức rung chuông báo động khi nhìn vào mã?

Nhiều điều tốt đã được đề cập, và nói chung có vẻ như không tuân theo các thực tiễn tốt nhất là mùi mã.

Thực hành tốt nhất thường không được phát minh ngẫu nhiên, và thường có lý do. Nhiều khi nó có thể chủ quan, nhưng theo kinh nghiệm của tôi thì hầu hết là hợp lý. Thực hiện theo các thực tiễn tốt nhất không phải là một vấn đề và nếu bạn đang tự hỏi tại sao chúng lại như vậy, hãy nghiên cứu nó thay vì phớt lờ và / hoặc phàn nàn về nó - có thể nó hợp lý, có thể không phải vậy.

Một ví dụ về cách thực hành tốt nhất có thể là sử dụng curlies với mọi khối if, ngay cả khi nó chỉ chứa một dòng:

if (something) {
    // whatever
}

Bạn có thể không nghĩ rằng nó cần thiết, nhưng gần đây tôi đã đọc rằng đó là một nguồn chính của lỗi. Luôn luôn sử dụng dấu ngoặc cũng đã được thảo luận về Stack Overflow và kiểm tra xem các câu lệnh if có dấu ngoặc cũng là một quy tắc trong PMD , một công cụ phân tích mã tĩnh cho Java.

Hãy nhớ rằng: "Bởi vì đó là cách thực hành tốt nhất" không bao giờ là câu trả lời chấp nhận được cho câu hỏi "tại sao bạn lại làm điều này?" Nếu bạn không thể nói rõ tại sao một cái gì đó là một thực tiễn tốt nhất, thì đó không phải là một thực tiễn tốt nhất, đó là một sự mê tín.

Những bình luận nói rằng "điều này là do thiết kế của hệ thống con froz hoàn toàn bị bó buộc."

Điều đó diễn ra trên toàn bộ một đoạn.

Họ giải thích rằng các cấu trúc lại sau đây cần phải xảy ra.

Nhưng đã không làm điều đó.

Bây giờ, họ có thể đã được thông báo rằng họ không thể thay đổi nó bởi ông chủ của họ vào thời điểm đó, vì vấn đề thời gian hoặc năng lực, nhưng có lẽ đó là do mọi người nhỏ mọn.

Nếu một giám sát viên nghĩ rằng j.random. lập trình viên không thể thực hiện tái cấu trúc, sau đó người giám sát nên thực hiện.

Dù sao, điều này xảy ra, tôi biết mã được viết bởi một nhóm bị chia rẽ, với chính trị quyền lực có thể, và họ đã không tái cấu trúc các thiết kế hệ thống con.

Câu chuyện có thật. Nó có thể xảy ra với bạn.

Bất cứ ai cũng có thể nghĩ về một ví dụ trong đó mã nên tham chiếu hợp pháp một tệp theo đường dẫn tuyệt đối?

Nắm bắt các ngoại lệ chung:

try {

 ...

} catch {
}

hoặc là

try {

 ...

} catch (Exception ex) {
}

Khu vực lạm dụng

Thông thường, sử dụng quá nhiều vùng cho tôi biết rằng các lớp học của bạn quá lớn. Đó là một lá cờ cảnh báo báo hiệu rằng tôi nên điều tra thêm về đoạn mã đó.

Các quy ước đặt tên lớp thể hiện sự hiểu biết kém về sự trừu tượng mà họ đang cố gắng tạo ra. Hoặc điều đó không định nghĩa một sự trừu tượng nào cả.

Một ví dụ cực đoan xuất hiện trong lớp VB tôi đã thấy một lần có tiêu đề Datavà dài hơn 30.000 dòng ... trong tệp đầu tiên . Đó là một lớp một phần được chia thành ít nhất nửa tá các tệp khác. Hầu hết các phương thức là các hàm bao quanh các procs được lưu trữ với tên như thế nào FindXByYWithZ().

Ngay cả với những ví dụ ít kịch tính hơn, tôi chắc chắn rằng tất cả chúng ta chỉ 'đổ' logic vào một lớp học được hình thành kém, đặt cho nó một tiêu đề hoàn toàn chung chung và hối hận về sau.

Các chức năng thực hiện lại chức năng cơ bản của ngôn ngữ. Ví dụ: nếu bạn từng thấy phương thức "getStringL wavel ()" trong JavaScript thay vì gọi đến thuộc tính ".length" của chuỗi, bạn biết bạn đang gặp rắc rối.

#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...

Tất nhiên không có bất kỳ loại giấy tờ và thỉnh thoảng lồng #defines