Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[T6A1][F14-B1]Leon Mak #498

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

leonmak
Copy link

@leonmak leonmak commented Mar 2, 2017

No description provided.

Copy link

@chanjunweimy chanjunweimy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job @leonmak

import seedu.addressbook.data.exception.IllegalValueException;
import seedu.addressbook.storage.Storage.StorageOperationException;

public abstract class Storage {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This class and its methods should have a header comments. If not, developers who needs to inherit from this class will not know how exactly they should override the methods and other developers who write client code for this class will not know how to use it either.

}
}

public abstract void save(AddressBook addressBook) throws StorageOperationException;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is better to give the method header comments in the parent class rather than the child class. The child class can inherit the comment from the parent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants