I think it is much better to focus on writing clear, concise, readable code, and only document the business purpose for code (where the purpose is not clear) than to worry about good documentation.
The documentation, in practice, rarely ever keeps up with the code changes. (At least in my experience)
发布评论
评论(2)
特殊的文档是一件主观的事情。
我认为专注于编写清晰、简洁、可读的代码,并且只记录代码的业务目的(目的不明确的地方)比担心良好的文档要好得多。
实际上,文档很少跟上代码的变化。 (至少根据我的经验)
Exceptional documentation is a subjective thing.
I think it is much better to focus on writing clear, concise, readable code, and only document the business purpose for code (where the purpose is not clear) than to worry about good documentation.
The documentation, in practice, rarely ever keeps up with the code changes. (At least in my experience)
Telerik 通常会很好地记录他们的代码。您可以亲自查看 Codeplex 上的 MVC 扩展项目。
Telerik usually documents their code exceptionally well. Check out their MVC extensions project on Codeplex to see for yourself.