数组索引与“用户文档”术语?

时间:2010-09-03 15:28:59

标签: c++ c documentation

我有一个字节的“数组”,在某些高级客户端/开发人员文档中引用(它不包含任何编程语言或环境特定信息)。在本文档中,字节当前称为“字节3”或“字节17”等。开发环境是C / C ++,字节存储在一个数组中,其中起始索引为0(当然)。

问题在于开发人员可能(已经)将文档中的“字节3”解释为myarray [3]或myarray [2]。

人们使用什么样的术语来区分“字节数”与“数组索引”的区别,但是对于(非程序员)客户端和开发人员来说,它是否可读?

4 个答案:

答案 0 :(得分:4)

  

人们使用什么样的术语来区分“字节数”与“数组索引”的区别,但是对于(非程序员)客户端和开发人员来说,它是否可读?

数组索引从0开始。(或者,1。采取立场并在设计文档中说明。)

答案 1 :(得分:4)

一种可能性就是直接说明你开始计算的地方。另一种可能性是使用“第一字节”,“第十七字节”等内容。第三个(我通常喜欢的那个)就是从基地址的偏移量来说。

答案 2 :(得分:2)

您可以从文档中删除对阵列中位置的所有引用。

给一些有意义的名字。

然后在程序中使用常量将名称映射到数组中的位置。

答案 3 :(得分:0)

检查文档是否存在“字节0”。