How does the ASDoc utility tool handle unsupported tags ? The reason for me to think about this is that I wish to have an easily followable standard for TODO, FIXME, HACK and BRAG tags in our codebase.
In general it seems like the most common standard is as follows: // [Tag]: [Description] Example... // TODO: Don't forget to clear the cache However, I was thinking about copying the existing standard: /** * [Description] * @param [Description] * @return [Description] */ so in the end I would have something like this: /** * Constructor for the Mediator, should be called by the controller and hence not directly * @param component This is the component for which the mediator will do its work * @fixme This argument should not be optional according to Dep.Inj. pattern * @todo Bind EventListeners to the component passed in as argument */
