TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

The Best Code Documentation ‘Tool’ Ever Made

8 pointsby martinnormarkalmost 11 years ago

2 comments

ASneakyFoxalmost 11 years ago
The method comments are where you explain the expected&#x2F;accepted inputs and outputs. Its not for outlining design decisions. You also don&#x27;t need to explain how the method works. It&#x27;s a black box.<p>Your ide can be configured to show warnings if your comments don&#x27;t match your parameter list. Though generally you don&#x27;t change the external api of your code once you&#x27;ve written it. Or else you then have to update all the methods that call it.
thegreenroomalmost 11 years ago
so your using function names instead of comments?
评论 #7969502 未加载