search

vhart / InterviewFlashCards

14 stars 17 forks source link

Documentation at the top of each class #26

Closed mesbekmek closed 8 years ago

mesbekmek commented 8 years ago

Should we remove the automatic comments that are generated at the top e.g (Created by person X...) and replace with it a one-liner like "Interview Flash Cards", or should we remove it completely?

At Spotify, and I'm sure at Shopkeep as well, we don't really keep those auto-generated comments, but this isn't a company so I'm wondering what your thoughts are. @vhart @charleshkang

charleshkang commented 8 years ago

So I asked a few other devs and they said to remove them completely. They also said Interview Flash Cards would add nothing to the project, which I agree with...If we're going to remove the author line, just remove everything.

Lemme know what you guys think

vhart commented 8 years ago

They should be removed completely @mesbekmek @charleshkang. They add nothing really. If you guys agree then lets open an issue for it.

charleshkang commented 8 years ago

Yeah, sounds good to me