2010-09-03 44 views
2

我有一些在高級客戶端/開發人員文檔(不包含任何編程語言或特定環境信息)中引用的字節「數組」。在本文檔中,字節當前稱爲「字節3」或「字節17」等。開發環境爲C/C++,字節存儲在起始索引爲0(自然地)的數組中。數組索引與「用戶文檔」術語?

問題是,開發人員可能會(已)將文檔中的「字節3」解釋爲myarray [3]或myarray [2]。

人們使用什麼樣的術語來使「字節數」與「數組索引」的區別變得清晰,但讓(非程序員)客戶和開發人員都能讀懂它們?

+2

爲什麼非程序員客戶端會關心或需要了解各個字節的含義?我希望任何需要使用這類信息的人都能熟悉數組在計算機程序中的索引。 – 2010-09-03 15:33:16

+0

我相信在說「Nr。3」時,大多數人認爲基於1,而在說「Idx。3」時大多數人認爲基於0。 – 2010-09-03 15:41:39

+0

該文檔由客戶代表從執行層級到開發人員級別進行審查。多個開發人員正在引用該文檔。它必須清楚給大家。作爲例子,考慮一個字符串,例如如商標,必須在可執行文件中,但由於某些原因文檔中調用了該字符串的特定字節。 – craigh 2010-09-03 15:45:08

回答

4

一種可能性是直接說明你開始計數的位置。另一種可能性是使用諸如「第一字節」,「第十七字節」等等。第三個(我通常更喜歡的)是用基地址的偏移量來說話。

+1

從基地址 – atzz 2010-09-03 15:40:52

+0

偏移+1我喜歡這個,或者至少是它的一個變種。 「第一」,「第二」等確實被大多數人解釋爲指代從「1」開始的序列。我認爲術語的組合很好,比如「序列號的第一個字節(serial_num [0])將被使用......」。 – craigh 2010-09-03 15:51:40

+0

+1只是直接說明它。有時候,消除所有可能的混淆的最簡單方法就是明確陳述事情。 – TheUndeadFish 2010-09-03 18:02:39

4

人們使用什麼樣的術語來使「字節數」與「數組索引」的區別變得清晰,但讓(非程序員)客戶和開發人員都能讀懂它們?

數組索引從0開始(或者1.取一個立場,並說明它的設計文件。)

+0

如果數組索引與字節數不匹配,請在myarray []定義的位置輸入一個很好的註釋。 – 2010-09-03 15:35:43

+0

+1 - 如果您承擔多種解釋風險,請通過在文檔中明確指出風險來降低風險。 – bstpierre 2010-09-03 18:56:51

0

檢查文件中是否存在一個「0字節」。

2

您可以從文檔中刪除對數組中位置的所有引用。

給事情一個有意義的名字。

然後在您的程序中將常量映射到數組中的某個位置。