注解如何影响Java代码可读性？

背景：代码注解在编程语言中已广泛流行，允许开发者将元数据附加到代码元素以定义自定义行为。许多现代框架和API使用注解使集成更简洁且更靠近对应代码元素。尽管有这些优势，从业者的轶事证据表明注解可能对代码可读性产生负面影响。目标：为更好理解这种影响，本文系统研究代码注解与代码可读性之间的关系。方法：在一项对软件开发者（n=332）的调查中，我们呈现15对带注解和不带注解的Java代码片段。这些对针对真实Java框架和API中使用的五类注解设计。调查参与者为每对选择他们认为更可读的代码片段，并回答一个关于注解如何影响代码可读性的开放问题。结果：所有注解使用类别的偏好分散，参与者之间没有共识。即使按参与者的编程或注解相关经验分组，答案仍然分散。然而，一些参与者在所有类别中表现出一致的支持或反对注解的偏好，这可能表明个人偏好。我们对开放问题的定性分析显示，参与者经常赞扬注解对设计、可维护性和生产力的影响，但对可理解性和代码清晰度表达了相反观点。结论：软件开发者和API设计者在决定是否使用注解时可以考虑我们的结果，并了解开发者对注解影响代码可读性持有相反观点。