KRYSTALM7 opened a new issue, #99: URL: https://github.com/apache/fineract-loan-origination/issues/99
## Description The LOS backend contains existing comments that are inconsistent in formatting, wording, and accuracy. Many don't follow Apache Fineract conventions, some are incomplete, outdated, or unnecessarily verbose. This issue is to **review and clean up existing comments** to bring them in line with the style used across the broader Fineract codebase. > This is **not** a task to add comments where none exist. ## Example of Inconsistency **Verbose with HTML markup (current style in parts of the codebase):** ### Screenshot The attached screenshot shows examples of the inconsistent existing comment formatting in the backend. The screenshot is an example only. The complete backend, including tests, should be reviewed. <img width="1440" height="674" alt="Image" src="https://github.com/user-attachments/assets/7ddf093d-58af-4688-a081-af053d163187"; /> --- **Clean and concise (preferred style):** ```java /** * Retrieves the loan application associated with the supplied identifier. * * @param applicationId identifier of the loan application * @return the requested loan application */ ``` Existing inline comments should follow the same principles concise, meaningful, and explaining context or intent rather than restating what the code already does. ```java // Validate the application before calling the Fineract integration. ``` The goal is to normalize existing comments toward this clear, concise style, while avoiding unnecessary documentation where the code is already self-explanatory. ## Scope Review all existing comments across: - `src/main/java` - `src/test/java` Including class/method Javadocs, inline comments, and TODO/FIXME items. ## What to Change For each existing comment, apply the following: - Rephrase unclear or poorly worded comments using concise language. - Correct grammar, spelling, and formatting. - Update comments that no longer accurately describe the implementation. - Remove HTML markup (`<p>`, `<ul>`, `<li>`) from Javadocs where plain prose suffices. - Remove comments that restate what the code already makes obvious. - Preserve valid TODO/FIXME items and their context. - Leave comments that are already clear, accurate, and well-formatted **unchanged**. ## Acceptance Criteria - [ ] Existing comments in `src/main/java` reviewed and cleaned up. - [ ] Existing comments in `src/test/java` reviewed and cleaned up. - [ ] Outdated, incorrect, or redundant comments corrected or removed. - [ ] No unnecessary new comments introduced. - [ ] Comment style is consistent with Apache Fineract conventions. - [ ] No business logic or application behavior is changed. - [ ] Backend tests continue to pass. ## Out of Scope - Adding Javadocs to classes/methods that have none. - Refactoring business logic or changing API contracts. - Introducing a new commenting style. --- This work may be divided into smaller sub-issues by backend layer, module, or package so that contributors can work on independent areas without overlapping changes. --- **JIRA:** [FINERACT-2442](https://issues.apache.org/jira/browse/FINERACT-2442) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
