Tại sao các biến không sử dụng là một vấn đề như vậy?

Một ngày nọ, tôi đang dọn dẹp các biến không sử dụng và tôi bắt đầu suy ngẫm, vấn đề chính xác là gì?

Trên thực tế, một số trong số chúng thậm chí còn giúp gỡ lỗi (ví dụ: kiểm tra chi tiết ngoại lệ hoặc kiểm tra giá trị trả về trước khi trả về).

Tôi không thể tìm thấy rủi ro thực sự khi có chúng ..

Ví dụ

Tôi không có nghĩa là các dòng mất thời gian chú ý của các lập trình viên khác, chẳng hạn như:

int abc = 7;

Đó là một sự dư thừa rõ ràng và mất tập trung. Ý tôi là những thứ như:

try {
    SomeMethod();
} catch (SomeException e) {
    // here e is unused, but during debug we can inspect exception details
    DoSomethingAboutIt();
}

Theo khung bạn đã đưa ra, thật khó để tranh luận với các biến đó mỗi lần:

try {
    SomeMethod();
} catch (SomeException e) {
// here e is unused, but during debug we can inspect exception details
DoSomethingAboutIt();
}

Lấy ví dụ này Bạn đang bắt một ngoại lệ và (có lẽ) có mã xử lý ngoại lệ đó một cách thích hợp. Thực tế là bạn không sử dụng ví dụ thực tế của ngoại lệ không có hại, đối với dòng mã cũng như không dễ hiểu.

Nhưng điều khiến tôi suy nghĩ là khi bạn viết về việc hợp pháp hóa »các biến không sử dụng«

Trong thực tế, một số trong số họ thậm chí còn giúp gỡ lỗi

Đó không phải là mục đích của việc viết mã: phải gỡ lỗi sau. Để tránh những hiểu lầm, tôi phải nói rằng, tôi nhận thức rõ rằng, đôi khi bạn phải sửa mã của mình; và đôi khi gỡ lỗi là giải pháp. Nhưng nó không phải là điều đầu tiên, điều bạn nghĩ đến, khi viết mã, bạn để lại "điểm neo", mục đích duy nhất của nó là làm cho việc gỡ lỗi dễ dàng hơn.

SomeClass Func() {
    // ...stuff...
    var ret = FinalComputationResult(thing, foo, bar);
    // ret is unused, but while debugging allows checking return value.
    return ret;
}

Ở đây nó phụ thuộc vào mức độ phức tạp stuffvà mức độ liên quan đến giá trị được trả về.

Là một "Nguyên tắc vàng", tôi sẽ nói như sau:

Nếu nó giúp hiểu được mục đích của mã, bạn có thể không bị thừa trong mã của mình

hoặc nói cách khác:

Viết mã của bạn dưới dạng dự phòng miễn phí là cần thiết để hiểu sau này dễ dàng, mã đang làm gì

Điều đó dẫn đến: Hầu hết thời gian, bạn nên xóa các biến "gỡ lỗi" .

Vấn đề lớn nhất là sự rõ ràng . Nếu mã của bạn có một đống rác ngoại lai trong đó và tôi đang duy trì mã của bạn, tôi phải tìm ra mọi thứ làm gì.

Là biến đó bao giờ được sử dụng cho bất cứ điều gì? Có lẽ bạn thực hiện các thao tác trên nó, nhưng không bao giờ sử dụng giá trị của nó cho một cái gì đó. Chỉ cần tăng một biến không có nghĩa là biến đó phục vụ mục đích nếu bạn không bao giờ đọc nó (trả về, nhập vào một biểu thức khác, et al).

Tuy nhiên: nếu một biến có mục đích và được đặt tên một cách thích hợp thì nó không làm mất đi toàn bộ mã.

Đưa ra các ví dụ trong câu hỏi cập nhật của bạn và một số người khác tôi nghĩ:

• Có một chức năng gọi một chức năng khác, lưu trữ kết quả, ghi lại nó, sau đó trả về nó là khá ngắn và rõ ràng.

• Việc tách một câu lệnh có nhiều biểu thức thành nhiều câu lệnh (ví dụ: tách một phép tính dài, phức tạp thành nhiều câu lệnh với nhiều biến trung gian) có thể làm cho mã rõ ràng hơn mặc dù dài dòng hơn. Với ít thông tin để xử lý tại một thời điểm, bộ não có thể dễ dàng dò dẫm những gì đang diễn ra.

• Không sử dụng ngoại lệ là hoàn toàn tốt: hầu hết các ngôn ngữ yêu cầu chỉ định ngoại lệ bị bắt bao gồm cung cấp tên biến được sử dụng trong catchkhối. Không có cách nào xung quanh điều này trong nhiều ngôn ngữ phổ biến và các lập trình viên đã quen với nó.

Nếu tôi cần dành thời gian để tìm ra các yếu tố mã nào có mục đích và điều đó chỉ làm lãng phí thời gian của tôi, năng suất của tôi sẽ giảm. Tuy nhiên, nếu mã khá ngắn gọn và các biến được đặt tên tốt ngay cả khi chúng có vẻ không liên quan lúc đầu, điều này sẽ giảm thiểu rủi ro lãng phí thời gian không cần thiết để xem lại mã để hiểu mã.

Mã xấu với các biến không liên quan, các khối trống và mã chết là một cách mà các nhà phát triển nhận được tiếng xấu xung quanh văn phòng: "Tôi đã sửa một lỗi trong mã của Snowman. Tôi đã dành hai giờ để tìm ra chức năng đó đang làm gì và ba mươi giây để sửa lỗi! Snowman rất tệ trong lập trình! " Nhưng nếu mã phục vụ một mục đích và được viết một cách rõ ràng, nó hoàn toàn ổn.

Các biến không được sử dụng không phục vụ mục đích rõ ràng là một mùi mã trong quan điểm của tôi. Tốt nhất, chúng có thể là một vật gây xao lãng - chúng thêm vào tiếng ồn chung trong mô-đun.

Trường hợp xấu nhất là các lập trình viên tiếp theo dành thời gian để tìm ra những gì nó phải làm và tự hỏi liệu mã đã hoàn thành. Làm cho mình (và mọi người khác) một ân huệ và thoát khỏi.

Các biến không được sử dụng làm cho ý định mã của bạn không rõ ràng. Điều này là xấu bởi vì mặc dù xuất hiện, mã chủ yếu được viết cho mọi người đọc, không phải cho máy tính .

Những người khác đã chỉ ra rằng việc xây dựng một giá trị và không sử dụng nó làm cho những người khác phải đọc và làm việc với mã của bạn nhầm lẫn. Tuy nhiên, theo quan điểm của tôi, mối nguy hiểm lớn hơn là cho chính bạn .

Một biến không được sử dụng có thể là cố ý hoặc nó có thể là một sự giám sát chỉ ra một khiếm khuyết. Chẳng hạn, bạn có thể đã nhập nhầm tên và lưu trữ một giá trị ở một nơi khi bạn nghĩ rằng bạn đã lưu nó ở một nơi khác. Chương trình kết quả có thể chạy tốt nhưng âm thầm đưa ra kết quả sai.

Phân tích luồng dữ liệu có thể giúp bạn tìm ra các lỗi như vậy và nhiều lỗi khác. Do đó, nó trả tiền để viết mã của bạn theo cách mà mọi thứ mà một bộ phân tích luồng dữ liệu chỉ ra là sự bất thường, trên thực tế, là một lỗi. Hỗ trợ tự động trong việc ngăn chặn lỗi là vô giá; nhiều người nghĩ rằng "Ồ, tôi không cần sự giúp đỡ, tôi sẽ không bao giờ bất cẩn như vậy", nhưng cho đến nay mọi người tôi đã gặp đều nghĩ rằng điều đó là sai.

Có một kiểu mã hóa liên quan đến việc cố tình gán bất cứ thứ gì đã (hoặc có thể trở thành) quan tâm cho một biến cho mục đích cụ thể là dễ dàng xem xét nó trong trình gỡ lỗi. Điều này đặc biệt hữu ích cho mã trông giống như:

return foo(bar(), baz(wot(12), wombat(&badger)));

Ngay cả với các tên tốt hơn cho các chức năng, có thể dễ dàng tìm ra những gì sai trong cuộc gọi đến foo khi được viết là:

auto awombat = wombat(&badger);
auto awot = wot(12);
auto abaz = baz(awot, abadger);
auto abar = bar();
auto afoo = foo(abar, abaz);
return afoo;

Tôi vẫn chưa làm việc với những người thực hành điều này như cấu hình mặc định, nhưng viết lại một đoạn mã cứng đầu từ chối không có ý nghĩa gì trong hình thức chuyển nhượng đơn lẻ có thể giúp dễ dàng tìm ra những gì đang diễn ra theo trình gỡ lỗi. Chúng tôi luôn hoàn nguyên mã trở lại định dạng nhỏ gọn, "đẹp" sau đó nhưng tôi tự hỏi liệu đó có phải là một lỗi không.

Giải pháp thay thế là đi lên và xuống ngăn xếp và hy vọng bạn không bước quá xa hoặc sử dụng các trình gỡ lỗi có thể đảo ngược (rất hiếm gặp).

Đây không phải là một chiến lược phổ biến, nhưng vì nó đã giúp tôi vượt qua một số lỗi vô lý, tôi không nghĩ rằng nó nên được viết ra vì bản chất là xấu.

Đối với những người bao gồm mã kiểm tra đơn vị của họ trong cùng các dự án hoặc mô-đun như mã "thực" của họ, một trường không được sử dụng , như phương thức đối tượng, là một tín hiệu mạnh mẽ rằng đơn vị của bạn kiểm tra không kiểm tra mọi thứ. Điều này làm tăng khả năng nhà phát triển sẽ cố gắng sử dụng trường hoặc phương thức hiện không được sử dụng đó và gặp phải lỗi không được phát hiện cho đến lúc đó.

Một biến không được sử dụng trong chương trình con hoặc phương thức không cần thiết có thể chỉ ra rằng người lập trình có nghĩa là sử dụng nó, nhưng đang sử dụng một biến khác do nhầm lẫn (giả sử, sau khi dọn dẹp sau thao tác sao chép-dán).

Một biến không được sử dụng trong chương trình con tầm thường hơn có lẽ là không cần thiết, như những người khác đã trả lời. Đôi khi, nó được sử dụng trong một tuyên bố về vụn bánh mì hiện đang được bình luận:

SomeObject tmp = someMethod();
// printDebugInfoAbout (tmp);

... rõ ràng với nhãn cầu rằng nó được sử dụng ở đó và chỉ ở đó (nghĩa là someMethodcó tác dụng phụ quan trọng), nhưng IDE không biết điều đó và việc loại bỏ biến đó còn rắc rối hơn giá trị của nó. Tôi tạm thời sử dụng các bộ triệt cảnh báo trong những trường hợp như vậy.

Thật dễ dàng khi bạn viết mã để trộn lẫn hai biến. Bạn tính một biến B nhưng sau đó sử dụng thay vì một số biến A được tạo trước đó.

Vì vậy, một lý do có thể cho một biến không được sử dụng là có một lỗi trong mã của bạn. Đó là lý do tại sao trình biên dịch cảnh báo bạn. Nếu bạn "không làm" các biến không sử dụng, nó thậm chí là một tặng cho đã chết.

Khi bạn thấy một cảnh báo như vậy, bạn nên xác minh mã của mình và sửa nó hoặc xóa biến vi phạm. Nếu bạn không xóa nó, bạn sẽ ngừng chú ý đến những cảnh báo này và bạn cũng có thể vô hiệu hóa chúng hoàn toàn. Nhưng sau đó, bạn cuối cùng sẽ mất một buổi chiều gỡ lỗi mã vì một sai lầm ngớ ngẩn.