Aryeh Gregor wrote: > Or whatever. We have *way* too few high-level comments in our code. > We have entire files -- added quite recently, mind you, by established > developers -- that have no or almost no documentation on either the > class or function level. We can really do better than this! If we > had a clear list of requirements for comments in new code, we could > start fixme'ing commits that don't have adequate comments. I think > that would be enough to get people to add sufficient comments, for the > most part. Without clear rules, though, backed up by the threat of > reverting, I don't think the situation will improve here.
What comment would you except to "public function getArticleText()"? By the way, is there a policy which describes where should we use get*/set* methods and where should we use public fields? --vvv _______________________________________________ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
