Documentez votre code!
J'ai récemment travaillé pour des clients qui voulaient que leur code soit écrit d'une manière particulière. OK pas de problème...
Ils m'ont donc laissé jeter un coup d'œil sur un projet précédent (mais non lié) sur lequel ils avaient travaillé. À ce stade, les choses sont devenues plus compliquées ... Le projet n'était pas documenté et le code était intelligent, laconique et totalement non commenté ...
Le résultat étant que j'ai dû «faire de l'ingénierie inverse» de leur projet précédent, afin de maîtriser leurs méthodes. Quelque chose qui, s'il y avait eu un document de projet, n'aurait pas été nécessaire!
Donc, dans un souci de maintenabilité et de bon sens du pauvre bugger parachuté pour vous aider avec votre code .... Merci de documenter vos projets et de commenter votre code!
Vous trouverez ci-dessous un exemple de code commenté et non commenté. Imaginez des centaines ou des milliers de lignes de code sans documentation ni commentaires!
Code without comments
var contentService = Services.ContentService;
var eventNode = contentService.CreateContent(
eventName,1105, UmbracoConstants.DocumentTypeAlias.EventItem,0);
Commented code
//======== create a new classified node using doc type - EventItem ============
// Get the Umbraco Content Service
var contentService = Services.ContentService;
var eventNode = contentService.CreateContent(
eventName, // the name of the event from Soap Call
1105, // the parent id should be the id of the group node
UmbracoConstants.DocumentTypeAlias.EventItem, // the alias of the product Document Type
0);
// We need to update properties (propertyType, content from Soap call)
