A lot of method parameters are documented with descriptions like "of user", "to do the alerts", and sometimes just "entity". To stick with convention, these description should be written out fully as "User ID", "User entity", "The untranslated Welsh limerick", etc.
What the variable will be used for can usually be summed up in the method description, but the @param description should be able to answer the question "What is this variable?" more clearly than "of tag" or "by alpha".
A lot of method parameters are documented with descriptions like "of user", "to do the alerts", and sometimes just "entity". To stick with convention, these description should be written out fully as "User ID", "User entity", "The untranslated Welsh limerick", etc.
What the variable will be used for can usually be summed up in the method description, but the
@paramdescription should be able to answer the question "What is this variable?" more clearly than "of tag" or "by alpha".