-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationeasygood first issueGood for newcomersGood for newcomers
Description
Description
- Detailed Description:
ThePortfolioInfoclass contains essential utility methods (e.g., calculating total portfolio value and distribution), but it lacks descriptive documentation. This can confuse new developers or students trying to understand the purpose and usage of these methods. - How to Solve:
- Add Javadoc Comments:
For each method inPortfolioInfo, add a Javadoc comment that describes its purpose, parameters, and return value. For example:/** * Calculates the total portfolio value by summing the product of current price and quantity for each stock. * * @param stocks List of Stock objects * @return The total portfolio value as a double */ public static double calculateTotalPortfolioValue(List<Stock> stocks) { ... }
- Repeat for All Public Methods:
Ensure that every public method in all utility classes is well documented. - Generate Documentation:
Optionally, generate the Javadoc HTML pages to verify that the documentation is clear.
- Add Javadoc Comments:
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationeasygood first issueGood for newcomersGood for newcomers