这对于跟非开发人员解释软件的运行来说非常之有用,同时也可作为针对后来者或者代码修改人员的一份很有价值的文档说明。
This can be valuable in explaining the software to non-developers or it could be useful documentation for when a software design needs to be learned by others and modified later.
否则,内联注释的出现表明你写的代码需要解释说明,意味着这些代码需要被重构。
Otherwise, the presence of inline comments indicates that you've written code that needs explanation, meaning that it cries out for refactoring.
文档说明用来解释代码是如何工作的,是写给读代码的人看的。
Docstrings explain how to use code, and are for the users of your code.
应用推荐