[DOCS] Add detailed line-by-line comments to updRouteAPSDates method (X++ class)
Documentation Type
Missing code examples
Documentation Location
_No response_
Section/Topic
updRouteAPSDates method in X++ class from user-provided code
Current Documentation
The code for updRouteAPSDates is provided without any inline comments or explanation. The logic is non-trivial, includes error handling, status validation, and updates to several tables.
What's Wrong or Missing?
The code lacks any inline or line-by-line comments explaining each operation, variable, and decision point. Developers will struggle to understand the flow, the purpose of each variable, the error handling, and the business rules being enforced, especially since there are conditional updates on multiple tables and status checks.
Suggested Improvement
Add detailed comments to each line and code block in the updRouteAPSDates method. Comments should explain the purpose of each variable, the logic behind company switching, the status checks, the reasons for transactional blocks, the update logic for ProdRoute, ProdRouteJob, and ReqTrans, and the error handling structure.
Impact
Medium - Makes feature difficult to understand
Additional Context
The code is an X++ method used for updating APS dates in production route/job tables with error handling and business logic. Detailed comments would help new and existing developers understand and safely modify or use this method.
This issue has 1 comment on GitHub. Read the full discussion on GitHub ↗