我应该记录我的私人方法吗？ [英] Should I document my private methods?

问题描述

专有方法文档只能由谁访问源代码。值得花费的努力吗？

Private methods documentation can only be seen by who has access to the source code. Is it worth the effort spent on it?

推荐答案

个人而言，我觉得是这样的。文档通常对未来开发人员维护您的软件（尤其是成员文档）最有用。

Personally, I feel that it is. Documentation is often the most useful to future developers maintaining your software - especially member documentation.

即使是公开的API文档，对开发人员以外的其他用户来说也是有限的。以下文件 - 他们会感谢你。

Even public API documentation is only of limited use to any audience other than a developer. Document for those following - they will thank you.

这篇关于我应该记录我的私人方法吗？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！