NeitzelLib/.github/JavaDoc-rules.md
Konrad Neitzel 93de125e67 Add guidelines for Copilot usage and commit messages
Updated dependencies and use Java 25.
2025-11-29 22:47:48 +01:00

957 B

JavaDoc should be included for: []: # - All public, protected and private classes and interfaces []: # - All public, protected and private methods and constructors []: # - Any method that overrides a superclass method []: # 3. If JavaDoc is missing, please add it following these guidelines: []: # - Use clear and concise language to describe the purpose and functionality. []: # - Include descriptions for all parameters using @param tags. []: # - Include a description of the return value using @return tags. []: # - Mention any exceptions that the method might throw using @throws tags. []: # - Follow standard JavaDoc formatting conventions. []: # 4. After adding JavaDoc, review it for clarity and completeness. []: # 5. Commit your changes with a message indicating that JavaDoc has been added or updated. []: # []: # By following these instructions, we can ensure that our codebase remains well-documented and easy to understand for all contributors.