comments.rst: 新翻译章节「7.9. 弃用注释」

This commit is contained in:
Isaac Ge 2015-07-23 20:21:17 +08:00
parent 4468cb9527
commit 70aeebb0af

View File

@ -252,6 +252,20 @@ NULL, true/false, 1, 2, 3...:
如果加 ``TODO`` 是为了在 "将来某一天做某事", 可以附上一个非常明确的时间 "Fix by November 2005"), 或者一个明确的事项 ("Remove this code when all clients can handle XML responses.").
7.9. 弃用注释
.. tip::
通过弃用注释(``DEPRECATED`` comments以标记某接口点interface points已弃用。
您可以写上包含全大写的 ``DEPRECATED`` 的注释,以标记某接口为弃用状态。注释可以放在接口声明前,或者同一行。
``DEPRECATED`` 一词后,留下您的名字,邮箱地址以及括号补充。
仅仅标记接口为 ``DEPRECATED`` 并不会让大家不约而同地弃用您还得亲自主动修正调用点callsites或是找个帮手。
修正好的代码应该不会再涉及弃用接口点了,着实改用新接口点。如果您不知从何下手,可以找标记弃用注释的当事人一起商量。
译者 (YuleFox) 笔记
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~