nus-cs2103-AY2021S1 / forum

20 stars 2 forks source link

How to reference a method in the DG #362

Open damithc opened 4 years ago

damithc commented 4 years ago

[Received from a student]

How do we properly quote methods in our developer guide? I am not sure whether we need to include the parameters of a method.

Using AB3 example, do we write AddCommand#execute(model) or AddCommand#execute() ?

damithc commented 4 years ago

Can omit parameters if doing so doesn't cause ambiguities. Also, you can use AddCommand#execute(...) to indicate that parameters have been omitted.

seanjyjy commented 4 years ago

@damithc . Hi Prof, can this be applied to the sequence diagram as well? (or whatsoever diagrams). It helps the diagram to be more compact and readable.

damithc commented 4 years ago

@damithc . Hi Prof, can this be applied to the sequence diagram as well? (or whatsoever diagrams). It helps the diagram to be more compact and readable.

Yes @seanjyjy