函数文档中动词的单数第三人称
@Belleve的猜测有可能是文档作者这样写的原因，但并不符合英语规范。省略主语时情态动词并不能一并省略，要这样写也应该是“Will return ...”。函数起名和文档里的人称问题是个广泛存在的问题，也没有权威规范，在StackOverflow问这样的问题会被当做opinion-based关掉。在实际应用里，大多数文档都贯彻第三人称单数，而函数起名则是动词原形和三单混用：class Foo { void DoSomething(); bool IsInitialized(); }一般解释是前者是动作，所以用第二人称命令句；后者是查询，所以用第三人称陈述或疑问句。但这解释不了GetXyz而不是GetsXyz，有人说是为和SetXyz对称的特例。而Ruby里查询类方法也用动词原形，松本行弘在FAQ里是这样解释的：|"responds_to?" probably makes more sense to English speakers than |"respond_to?".Maybe. But I\u0026#39;m Japanese. Ruby is not English. It\u0026#39;s the basic namingrule to avoid third person singular form in the standard libraries. you = Human.new if you.respond_to?(:knock) ... end buddies = member.collect{|x| x.friend_of?(me)} buddies.respond_to?(:select)扯远了……回到题主说的文档，解释成命令语气还是比较奇怪的，所以确实应该加-s。
■网友
你可以理解成省略了 It will... 或者 Calling this function will...
推荐阅读
- python的html5lib这个库咋使用啊我在网上也没有找到相关文档
- 啥是微信开发WEB前端
- 需求文档外包怎样报价
- C语言指数函数代码
- 单例模式static函数必须在头文件中实现么
- 编写测试用例时参照实际项目还是需求文档
- 函数|你要来试试吗？高中数学丨越做越起劲的100道高中数学函数类压轴题
- 咋用c语言或java打点出函数图
- IT从业者需要达到怎么样的英语水平
- 为啥安卓上的kindle 不能同步个人文档