如果找不到用户,我有一个返回User的函数或nil。它看起来像这样:
# Given an access token in the HTTP headers, it returns the User who owns the token
#
# @return [User] the user who owns the access token
def set_api_user
token = /(.*)=\"(.*)\"/.match(request.headers["Authorization"])[2]
@api_user = ApiKey.find_by(access_token: token).user
end
我的问题是,如果找不到用户,我该如何记录?如果找不到用户,我该怎么说?
答案 0 :(得分:1)
忽略错误条件的代码行为等,在Yard中,您只需在备注中添加备选项:
# @return [User,nil] the user who owns the access token
Yard渲染器会用它做这样的事情:
(用户?)set_api_user
拥有访问令牌的用户
小问号是Yard的惯例,“也许你会得到这个,或者你可能会得到零”