I wasn't trying to force my conventions on anyone; I was just trying to make sure that I wasn't doing the same thing differently for no reason.
I put my userid in the actionable comments solely for the purpose of identifying that I wrote them. That way if someone else reads them and doesn't understand why they say what they say, they know who to ask for clarification. (You can always dig through the log messages; it's just a pain to do so.) I use more than a TODO, simply for the sake of making it easier to filter with an IDE or grep. Here's what the different tags mean: TODO: Identifies a missing or incomplete section of code. FIXME: Identifies temporary/broken code. (This type of code is sometimes put in place as a stopgap just to get things working.) REVIEW: Identifies code that may need further review. JAVADOC: Identifies missing or incomplete JAVADOC. -Bill On Mon, 2006-04-17 at 10:57 +0600, Ajith Ranabahu wrote: > Hi all, > Just as Glen said I (and most of the others too) use the //todo as a > flag but none of the other mentioned. I'm happy to have a convention > though > BTW we are not into putting user names/author names in the code! > > On 4/17/06, Glen Daniels <[EMAIL PROTECTED]> wrote: > > I tend to use at least //TODO: and //FIXME: (which IDEA also recognizes > > and flags). I'd be +1 for getting team buy-in for these conventions... > > > > --Glen > > > > Davanum Srinivas wrote: > > > Nope. We are in the wild-wild-west :) > > > > > > On 4/14/06, Bill Nagy <[EMAIL PROTECTED]> wrote: > > >> Hi folks, > > >> > > >> As I wander through the code, I'm adding comments where > > >> appropriate/missing. Are you following any particular conventions for > > >> task-related comments (e.g. //TODO: (<username>) <comment>, //FIXME: > > >> (<username>) <comment>, //REVIEW: (<username>) <comment>, //JAVADOC: > > >> (<username>) <comment>, etc. ?) > > > > > -- > Ajith Ranabahu
