Welcome to the Lounge

MarcusCole6833 wrote:

Is the code documenting itself good enough?

kmoorevs wrote:

you/they are doing something 'clever', then documenting/commenting is encouraged.

Comments may or may not get updated, but the code doesn't lie.

kmoorevs wrote:

Comments may or may not get updated, but the code doesn't lie.

interface IDataSaver(){
    int Save();
}

class InternetSaver : IDataSaver{
     String dataToSave;
    Int Save(){
        // 1.  Http write dataToSave to URL;
       //. 2. Return 0 - success
    }
}

class FileSaver : IDataSaver{
     String dataToSave;
    Int Save(){
        // 1.  File write dataToSave to FILE;
       //. 2. Return 0 - success
    }
}

class DBSaver : IDataSaver{
     String dataToSave;
    Int Save(){
        // 1.  write dataToSave to DATABASE;
       //. 2. Return 0 - success
    }
}

// driver
List<IDataSaver> allDataSavers  = new List<IDataSaver>();
allDataSavers.Add(new InternetSaver());
allDataSavers.Add(new FileSaver());
allDataSavers.Add(new DBSaver());

foreach (IDataSaver ds in allDataSavers){
    ds.Save(); /// no need to determine type (no switch) bec all implement Save()
}