Use one line for each parameter, so two parameters will have two lines. One asterisk (*), followed by followed by the name of the parameter, followed by a description of the parameter The comment should include a description of the method, the name and description of each parameter,Ī description of the return value, and the name and description of any exceptions thrown within the method using Javadoc keywords and formatting.īegins with a slash, followed by two asterisks (/**) * Stores the first, middle, and last names for a president.Įvery method definition should be preceded with a descriptive comment using the "Javadoc" notational convention. The comment should describe its purpose of the class. Multi-word identifiers are internally capitalized.ĭo not use hyphens or underscores to separate multi-word identifiers (except for constants, which have all upper case letters).įinal int DAYS_IN_YEAR = 365 //Use UPPER_CASE for constants (final variables)Įvery class should be preceded with a descriptive comment using the "JavaDoc" notational convention. Method names start with a lower case letter. Exception: use UPPER_CASE for constants - final variables.) (Variables include parameters, local variables, and data fields. Variable names start with a lower case letter. Use single letter identifiers only for the counter in loops.Ĭlass names start with an upper case letter. Use descriptive names for all variables, function names, constants, and other identifiers. Identifier Naming and Capitalization Guidelines
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |