ajaynegi33 / ajaynegi33/Http-Server

Improve Javadoc Comments

Ouverte
#2 11 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation good first issue hacktoberfest hacktoberfest-accepted status: ready for dev
Langage dominant
Java
Étoiles
10
Forks
16
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

**Description:**
The current Javadoc comments in the **Http-Server** project can be improved to enhance clarity and provide more beginner-friendly explanations. This will help new contributors better understand the code and contribute more easily.

**Tasks:**
1. Review the existing Javadoc comments across all classes and methods.
2. Simplify technical jargon and provide clear explanations.
3. Add examples where necessary to demonstrate how methods and classes are used.
4. Ensure consistency in formatting and language throughout the codebase.
5. Follow best practices for writing Javadoc comments:
- Briefly describe the purpose of the class or method.
- Explain all parameters and return values.
- Highlight any exceptions thrown by the method.
- Include relevant tags (e.g., `@param`, `@return`, `@throws`).

**Requirements:**
- Basic knowledge of Java and Javadoc format.
- Willingness to make the comments approachable for beginners.

**Additional Notes:**
Feel free to ask any questions or request clarifications in the comments below. Let's make this project more accessible to new contributors! 😊

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.