文章来源于网络收集而来,版权归原创者所有,如有侵权请及时联系!
具名函数参数 的注释
假设你见到下面这样的函数调用:
因为这里传入的整数和布尔型值,使得这个函数调用有点难以理解。
在像Python这样的语言中,你可以按名字为参数赋值:
在像C++和Java这样的语言中,你不能这样做。然而,你可以通过嵌入的注释达到同样的效果:
请注意我们给第一个参数起名为timeout_ms而不是timeout。从理想角度来讲,如果函数的实际参数是timeout_ms就好了,但如果因为某些原因我们无法做到这种改变,这也是“改进”这个名字的一个便捷的方法。
对于布尔参数来讲,在值的前面加上/*name=*/尤其重要。把注释写在值的后面让人困惑:
在上面这些例子中,我们不清楚false的含义是“使用加密”还是“不使用加密”。
大多数函数不需要这样的注释,但这种方法可以方便(而且紧凑)地解释看上去难以理解的参数。
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论