Let's talk in this post about code comments, around the following example. /// <summary> /// ... summary comments ... /// Note: If you change environment make sure you clear this file,as it will contain cached configuration /// </summary> public class ConfigurationPersister { public T GetConfiguration<T>() { ... } public void PersistConfiguration<T>(T configuration) { ... } internal bool HasConfiguration<T>() { ... } private string CreateConfigFileName(string fileName) { ... } private void CheckConfigDirectory() { ... } } Tags First thing that we might notify is the 'NOTE' part. For this kind of scenarios we should use custom tags like '<remarks>'. In this way the other developer that is using the ConfigurationPersister (class), can see more clearly any remarks. /// <summary> /// ... summary comments ...
DREAMER, CRAFTER, TECHNOLOGY ENTHUSIAST, SPEAKER, TRAINER, AZURE MVP, SOLVING HARD BUSINESS PROBLEMS WITH CUTTING-EDGE TECHNOLOGY