我应该缩写库中的变量和函数名称吗？答案

【问题标题】：Should I abbreviate variable and function names in a library?我应该缩写库中的变量和函数名称吗？
【发布时间】：2021-03-27 10:03:58
【问题描述】：

我正在开发一个 C 数据结构库，我希望我的代码清晰，没有太多的 cmets 并且仍然可读，但我正在努力命名。

我知道所有这些问题大部分都是一样的，但我需要让代码中的所有案例都清楚。

【问题讨论】：

这是一个基于意见的问题，不适合 StackOverflow 的问答形式，因为确实没有正确答案。只要确保你的函数名称一目了然，坚持一种大小写风格（例如camelCase vs snake_case），不要担心容易理解的常用缩写如cmp等。
另外，我建议您甚至不要尝试在 C 标准库中复制一些 (IMO) 奇怪的名称/命名样式（尤其是在 string.h 中出于某种原因）（例如strstr、strpbrk、alloca、strcspn 等）如果不使用谷歌搜索功能的目的，将很难理解。
C 标准库函数名称的原因是，过去编译器可能只使用标识符的前 8 个字符来区分函数……但自中世纪以来，C 实际上要求任何实现将考虑至少 31 个第一个字符。
@AnttiHaapala：所需的数量从来不是八个字符。在 1990 C 标准中为 6 个，在 1999 C 标准中为 31 个。我隐约记得 IBM 操作系统模块名称有一些命名方案以适应六个字符的限制。
@EricPostpischil 6？ :D 我的立场是正确的...6 significant initial characters in an external identifier

【解决方案1】：

stackInit() 和 listInit() 比 sinit() 和 linit() 更具可读性。

声明list_t *list 比list_t *ls 更具可读性。

至于你使用骆驼风格的函数名，那么当变量名与函数名不同时会更好。所以我更喜欢使用datasize 或data_size 而不是dataSize。

cmp 是单词compare 或comparison 的常用同义词。英特尔处理器有这样的汇编程序命令。所以你可以使用cmp、compare或comparison。

【讨论】：