Có phải tất cả các số ma thuật được tạo ra giống nhau?

Trong một dự án gần đây, tôi cần chuyển đổi từ byte sang kilobyte kibibyte . Mã này đủ đơn giản:

var kBval = byteVal / 1024;

Sau khi viết nó, tôi đã làm cho phần còn lại của chức năng hoạt động và chuyển sang.

Nhưng sau này, tôi bắt đầu tự hỏi liệu tôi có nhúng số ma thuật vào mã của mình không. Một phần trong tôi nói rằng nó ổn vì số này là một hằng số cố định và nên dễ hiểu. Nhưng một phần khác của tôi nghĩ rằng nó sẽ cực kỳ rõ ràng nếu được bọc trong một hằng số xác định như thế nào BYTES_PER_KBYTE.

Vì vậy, những con số là hằng số nổi tiếng có thực sự kỳ diệu hay không?

Câu hỏi liên quan:

Khi nào một số là một số ma thuật? và Có phải mọi số trong mã được coi là "số ma thuật"? - tương tự, nhưng là những câu hỏi rộng hơn nhiều so với những gì tôi đang hỏi. Câu hỏi của tôi tập trung vào các số không đổi nổi tiếng không được giải quyết trong các câu hỏi đó.

Loại bỏ số ma thuật: Khi nào là lúc nói "Không"? cũng liên quan, nhưng tập trung vào tái cấu trúc trái ngược với việc một số không đổi có phải là số ma thuật hay không.

Không phải tất cả các số ma thuật đều giống nhau.

Tôi nghĩ trong trường hợp đó, hằng số đó là OK. Vấn đề với các con số ma thuật là khi chúng là ma thuật, tức là không rõ nguồn gốc của chúng là gì, tại sao giá trị đó là gì, hoặc giá trị đó có chính xác hay không.

Ẩn 1024 phía sau BYTES_PER_KBYTE cũng có nghĩa là bạn không thấy ngay lập tức nếu nó đúng hay không.

Tôi sẽ mong mọi người biết ngay tại sao giá trị là 1024. Mặt khác, nếu bạn đang chuyển đổi byte thành megabyte, tôi sẽ xác định hằng số BYTES_PER_MBYTE hoặc tương tự vì hằng số 1.048.576 không rõ ràng đến mức 1024 ^ 2, hoặc thậm chí còn đúng

Điều tương tự cũng xảy ra đối với các giá trị được quyết định bởi các yêu cầu hoặc tiêu chuẩn, chỉ được sử dụng ở một nơi. Tôi thấy chỉ cần đặt đúng hằng số với một nhận xét cho nguồn có liên quan để dễ xử lý hơn là xác định nó ở nơi khác và phải đuổi cả hai phần xuống, ví dụ:

// Value must be less than 3.5 volts according to spec blah.
SomeTest = DataSample < 3.50

Tôi thấy tốt hơn

SomeTest = DataSample < SOME_THRESHOLD_VALUE

Chỉ khi SOME_THRESHOLD_VALUEđược sử dụng ở nhiều nơi, sự đánh đổi mới trở nên đáng giá để xác định một hằng số, theo ý kiến ​​của tôi.

Có hai câu hỏi tôi đặt ra khi nói về số ma thuật.

Số có tên không?

Tên rất hữu ích vì chúng ta có thể đọc tên và hiểu mục đích của số đằng sau nó. Các hằng số đặt tên có thể tăng khả năng đọc nếu tên dễ hiểu hơn số mà nó thay thế và tên hằng là ngắn gọn.

Rõ ràng, các hằng số như pi, e, et al. có tên ý nghĩa. Một giá trị như 1024 có thể là BYTES_PER_KBnhưng tôi cũng mong rằng bất kỳ nhà phát triển nào cũng sẽ biết 1024 có nghĩa là gì. Đối tượng dự định cho mã nguồn là các lập trình viên chuyên nghiệp, những người cần có kiến ​​thức nền tảng để biết nhiều quyền hạn khác nhau và lý do tại sao chúng được sử dụng.

Nó được sử dụng ở nhiều địa điểm?

Trong khi tên là một thế mạnh của hằng số, một cái khác là tái sử dụng. Nếu một giá trị có khả năng thay đổi, nó có thể được thay đổi ở một nơi thay vì cần phải săn lùng nó ở nhiều địa điểm.

Câu hỏi của bạn

Trong trường hợp câu hỏi của bạn, tôi sẽ sử dụng số nguyên trạng.

Tên: có một tên cho số đó, nhưng nó không thực sự hữu ích. Nó không đại diện cho hằng số toán học hoặc giá trị được chỉ định trong bất kỳ tài liệu yêu cầu nào.

Địa điểm: ngay cả khi được sử dụng ở nhiều địa điểm, nó sẽ không bao giờ thay đổi, phủ nhận lợi ích này.

Trích dẫn này

Đó không phải là con số đó là vấn đề, đó là phép màu.

như đã nói bởi Jörg W Mittag trả lời câu hỏi này khá tốt.

Một số con số đơn giản là không có phép thuật trong một bối cảnh cụ thể. Trong ví dụ được cung cấp trong câu hỏi, các đơn vị đo được chỉ định bởi các tên biến và thao tác đang diễn ra khá rõ ràng.

Vì vậy, 1024không có gì kỳ diệu bởi vì bối cảnh làm cho nó rất rõ ràng rằng đó là giá trị phù hợp, không đổi để sử dụng cho các chuyển đổi.

Tương tự như vậy, một ví dụ về:

var numDays = numHours / 24; 

cũng rõ ràng và không kỳ diệu bởi vì nó được biết rằng có 24 giờ trong ngày.

Các áp phích khác đã đề cập rằng việc chuyển đổi xảy ra là 'rõ ràng', nhưng tôi không đồng ý. Câu hỏi ban đầu, tại thời điểm này, bao gồm:

kilobyte kibibytes

Vì vậy, tôi đã biết tác giả là hoặc đã nhầm lẫn. Trang Wikipedia thêm vào sự nhầm lẫn:

1000 = KB kilobyte (metric)
1024 = kB kilobyte (JEDEC)
1024 = KiB kibibyte (IEC)

Vì vậy, "Kilobyte" có thể được sử dụng để chỉ cả hai yếu tố 1000 và 1024, với sự khác biệt duy nhất về tốc ký là cách viết hoa của 'k'. Trên hết, 1024 có thể có nghĩa là kilobyte (JEDEC) hoặc kibibyte (IEC). Tại sao không phá vỡ tất cả sự nhầm lẫn đó hoàn toàn với một hằng số với một tên có ý nghĩa? BTW, chủ đề này đã sử dụng "BYTES_PER_KBYTE" thường xuyên và điều đó không kém phần mơ hồ. KBYTE: đó là KIBIBYTE hay KILOBYTE? Tôi muốn bỏ qua JEDEC và có BYTES_PER_KILOBYTE = 1000và BYTES_PER_KIBIBYTE = 1024. Không còn nhầm lẫn.

Lý do tại sao những người như tôi, và nhiều người khác ở ngoài đó, có 'chiến binh' (để trích dẫn một người bình luận ở đây) ý kiến ​​về việc đặt tên số ma thuật là tất cả về tài liệu những gì bạn định làm và xóa bỏ sự mơ hồ. Và bạn thực sự đã chọn một đơn vị đã dẫn đến rất nhiều nhầm lẫn.

Nếu tôi thấy:

int BYTES_PER_KIBIBYTE = 1024;  
...  
var kibibytes = bytes / BYTES_PER_KIBIBYTE;  

Sau đó, rõ ràng ngay lập tức những gì tác giả dự định làm, và không có sự mơ hồ. Tôi có thể kiểm tra hằng số trong vài giây (ngay cả khi nó nằm trong một tệp khác), vì vậy mặc dù nó không phải là 'tức thời', nhưng nó đủ gần với tức thì.

Cuối cùng, nó có thể rõ ràng khi bạn viết nó, nhưng nó sẽ ít rõ ràng hơn khi bạn quay lại sau đó, và nó thậm chí có thể ít rõ ràng hơn khi người khác chỉnh sửa nó. Phải mất 10 giây để tạo ra một hằng số; Có thể mất nửa giờ hoặc hơn để gỡ lỗi một vấn đề với các đơn vị (mã sẽ không nhảy ra khỏi bạn và cho bạn biết các đơn vị sai, bạn sẽ phải tự mình làm toán để tìm ra điều đó, và bạn có thể sẽ săn lùng 10 con đường khác nhau trước khi bạn kiểm tra các đơn vị).

Việc xác định tên khi đề cập đến một giá trị số cho thấy rằng bất cứ khi nào cần một giá trị khác ở một nơi sử dụng tên đó, thì tất cả sẽ cần thiết. Nó cũng có xu hướng đề xuất rằng thay đổi giá trị số được gán cho tên là một cách hợp pháp để thay đổi giá trị. Hàm ý như vậy có thể hữu ích khi nó đúng và nguy hiểm khi nó sai.

Việc hai nơi khác nhau sử dụng một giá trị theo nghĩa đen cụ thể (ví dụ 1024) sẽ gợi ý một cách yếu ớt rằng những thay đổi sẽ khiến lập trình viên thay đổi một phần nào đó có khả năng truyền cảm hứng cho lập trình viên muốn thay đổi người khác, nhưng hàm ý đó yếu hơn nhiều so với áp dụng nếu lập trình viên gán tên cho một hằng số như vậy.

Một mối nguy hiểm lớn với một cái gì đó giống như #define BYTES_PER_KBYTE 1024nó có thể gợi ý cho ai đó gặp phải printf("File size is %1.1fkB",size*(1.0/BYTES_PER_KBYTE));rằng một cách an toàn để làm cho mã sử dụng hàng ngàn byte sẽ là thay đổi #definecâu lệnh. Tuy nhiên, một sự thay đổi như vậy có thể là thảm họa, ví dụ, nếu một số mã không liên quan khác nhận được kích thước của một đối tượng trong Kbytes và sử dụng hằng số đó khi phân bổ bộ đệm cho nó.

Có thể hợp lý khi sử dụng #define BYTES_PER_KBYTE_FOR_USAGE_REPORT 1024và #define BYTES_PER_KBYTE_REPORTED_BY_FNOBULATOR 1024, gán một tên khác cho mọi mục đích khác nhau được phục vụ bởi hằng số 1024, nhưng điều đó sẽ dẫn đến nhiều định danh được xác định và sử dụng chính xác một lần. Hơn nữa, trong nhiều trường hợp, thật dễ hiểu giá trị nghĩa là gì nếu người ta nhìn thấy mã nơi nó được sử dụng và dễ nhất là tìm ra mã có nghĩa là gì nếu người ta thấy giá trị của bất kỳ hằng số nào được sử dụng trong đó. Nếu một chữ số chỉ được sử dụng một lần cho một mục đích cụ thể, thì việc viết chữ ở nơi được sử dụng thường sẽ mang lại mã dễ hiểu hơn là gán nhãn cho nó ở một nơi và sử dụng giá trị của nó ở một nơi khác.

Tôi sẽ nghiêng về việc chỉ sử dụng số, tuy nhiên tôi nghĩ một vấn đề quan trọng chưa được đưa ra: Cùng một số có thể có nghĩa là những điều khác nhau trong các bối cảnh khác nhau và điều này có thể làm phức tạp hóa việc tái cấu trúc.

1024 cũng là số lượng KiB trên mỗi MiB. Giả sử chúng ta sử dụng 1024 để thể hiện tính toán đó ở đâu đó hoặc ở nhiều nơi và bây giờ chúng ta cần thay đổi nó để tính GiB thay thế. Thay đổi hằng số dễ dàng hơn tìm kiếm / thay thế toàn cầu nơi bạn có thể vô tình thay đổi sai ở một số nơi hoặc bỏ lỡ nó ở những nơi khác.

Hoặc thậm chí có thể là một mặt nạ bit được giới thiệu bởi một lập trình viên lười biếng cần được cập nhật một ngày.

Đó là một ví dụ giả định nhưng trong một số cơ sở mã, điều này có thể gây ra sự cố khi tái cấu trúc hoặc cập nhật cho các yêu cầu mới. Trong trường hợp cụ thể này, tôi sẽ không coi số đơn giản là dạng thực sự xấu, đặc biệt nếu bạn có thể đưa phép tính vào một phương thức để sử dụng lại, tôi có thể sẽ tự làm điều đó nhưng xem xét hằng số 'chính xác hơn'.

Nếu bạn sử dụng các hằng số được đặt tên, như supercat nói, điều quan trọng là phải xem xét liệu bối cảnh có quan trọng không, và nếu bạn cần nhiều tên.