The following are some common annotation variables and descriptions that can be used selectively by class or method when scheduling

First, common notes

/ * * *@nameName *@abstractDeclare variables/classes/methods *@accessSpecifies the access to this variable, class, function/method *@authorFunction author's name and email address *@categoryOrganize packages *@copyrightSpecify copyright information *@constSpecify constant *@deprecateIndicates not recommended or deprecated information *@exampleThe sample *@excludeIndicates that the current comment will not be parsed and will not appear in the document *@finalIndicates that this is a final class, method, or property, and does not allow derivation or modification. *@globalSpecifies the global variable * referenced in this function@includeSpecifies information about the included file *@linkDefine online connections *@moduleDefine the owning module information *@modulegroupDefines the owning module group *@packageDefines the information for the owning package *@paramDefines parameter information for a function or method *@returnDefines the return information of a function or method *@seeDefine the functions and variables that need to be referenced, and add the corresponding hyperlinks. *@sinceSpecifies the version from which the API function or method was introduced@staticSpecifies that a variable, class, or function is static. *@throwsSpecifies the error exceptions that this function may throw, and what happens@todoIdentify areas that should be improved or not@varDefine specification variables/attributes. *@versionDefine version information */

Copy the code

Second, make a demo

These comments are almost always added to code these days, so it doesn’t look very refreshing

Note: the code is quickly generated oh, programmers are very lazy, do not know how to knock, how tired ah

Attached is a quick configuration method to generate annotations. If you haven’t configured it, please try it, isn’t it very considerate (remember to open the larger picture to view it)