search

nshian / nus-cs2113-pe

0 stars 0 forks source link

Missing accessibility of attributes and methods in 1st class diagram for DG #17

Open nshian opened 1 year ago

nshian commented 1 year ago

The accessibility of the attributes and methods in the classes for the 1st class diagram in the DG should have been included e.g. for a private attribute, prefix it with a "-" or for a public method, prefix it with a "+".

These details are missing from the class diagram which can cause confusion for the programmer reviewing the guide.

image.png

nus-se-script commented 1 year ago

Team's Response

No details provided by team.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.High]

Reason for disagreement: With no indication of the access modifiers of the attributes and methods for the classes, developers/programmers reading the guide are not able to fully comprehend how the classes interact with one another. Moreover, there is no other class diagram in the DG that explains this further. This can serve as a serious obstacle/roadblock in a future developer's brainstorming of how to extend the application further, and would also require them to go through the tedious process of manually reading the code and to determine the access modifier for each and every attribute + method which can be avoided if these details were included in the class diagram to begin with.

If there was omittance for only 1 or 2 classes, I think there is some argument for this to be a Low severity bug. However, the omittance of access modifiers is for ALL classes; for this reason and the reasons stated above, I think this bug should be adjusted to a Medium severity one at least.