java - Is there a way to define 'javadoc types' - custom parameters for members? -

The issues that I can think of are the following:

In a normal application, Many members of the class, like a web application, have several constant key keys, action classes, services etc. For each category, it is useful for continuous documenting, to maintain consistency.

The constants used for the attribute key:

  / ** * request {@link com.acme.domain.User} Object's Scope feature key {@link LoginAction}. * / Public Static Last String USER_KEY = "com.acme.web.user";  

Each attribute key is usually used by a 'Javadock type / category' of its scope, the type of object stored in it, which sets it, and who it is for the following types Will be from:

  / ** * @ attribute that * @scope request * @ type com.acme.domain.user * @source com.acme. Web.action.LoginAction # processLogin () * @for Homepage. Jsp * / Public Stable Last String USER_KEY = ...;  

Of course, the documentation tags provided should be translated into English to translate. An important part of the above plan is the @type tag - this documentation will allow the authors to include all required fields or face warning messages.

I am almost positive that such a thing is not present for Java, but will it be useful and there is such a feature in other languages ​​/ documentation systems?

I should think about what you are talking about (semantic, obstacles, contract , Etc.) This would be a better match.