[visualC#] Summary na variabele declaratie

[Zartok]

Ik wil de comments die bij de variabelen in een class staan, achter de declaratie hebben in plaats van daarboven. Dus in plaats van zo:

C#:

/// <summary>The raw data that is obtained from the url</summary>       
public string rawData;
/// <summary>Time and date of the latest acquisition</summary>
public DateTime timeStamp;
/// <summary>Acquired information in element format</summary>
private element content;
/// <summary>Is the rawData processed to an element</summary>
private bool processed;
/// <summary>Should the rawData be processed to an element</summary>
private bool process;

wil ik het zo hebben:

C#:

public string rawData;     /// <summary>The raw data that is obtained from the url</summary>
public DateTime timeStamp; /// <summary>Time and date of the latest acquisition</summary>
private element content;   /// <summary>Acquired information in element format</summary>
private bool processed;    /// <summary>Is the rawData processed to an element</summary>
private bool process;      /// <summary>Should the rawData be processed to an element</summary>

Maar als ik het op de laatste manier doe dan pakt intellitype steeds de volgende, want dan natuurlijk weer logisch is, maar is er een toevoeging of vervanging van summary zodat het commentaar wel achter de declaratie kan staan EN intellitype het goede commentaar pakt?

[Lustucru]

En dit heb je in CSA geplaatst omdat?
CSA-->PRG

[Zartok]

Het subforum waar je vragen kan stellen over kant en klare clientprogramma's en -scripts, inclusief de installatie daarvan. Ook problemen met Office-producten kun je hier bepreken, dus ook de volgende zaken horen in CSA:
Je wil weten hoe je een rapport op een bepaalde manier laat weergeven in Access.
De door jou gemaakte Word-macro werkt niet zoals je wil.

In dit geval heeft het puur te maken visual studio en niet met de taal C# of manier van programmeren te maken, dus dacht ik dat het daar hoorde. Maar dank voor het op de juiste plaats zetten van het topic.

[Styxxy]

Als je die er achter zet, verlies je dan niet de IntelliSense informatie die deze comments voorzien?

[Zartok]

Je verliest het niet, maar alles schuift een plekje door, voor IntelliSense is het dan immers hetzelfde als dat ze eronder zouden staan, waardoor het commentaar bij de verkeerde variabele komt te staan. Nou vond ik na googlen dat je cref kan gebruiken om het op een andere plek te zetten, maar dat lijkt alleen voor classes te gelden en niet voor variabele declaraties binnen een class

C#:

///<summary cref="rawData">commentaar</summary>

werkt voor de class rawData, maar niet voor de variabele rawData binnen een class. Maar ik vroeg me af of iemand wist of je iets vergelijkbaars toe kan passen voor variabelen, dat kon ik namelijk niet vinden.

[Woy]

Zartok schreef op vrijdag 16 augustus 2013 @ 12:10:
Maar als ik het op de laatste manier doe dan pakt intellitype steeds de volgende, want dan natuurlijk weer logisch is, maar is er een toevoeging of vervanging van summary zodat het commentaar wel achter de declaratie kan staan EN intellitype het goede commentaar pakt?

Heel simpel antwoord: Nee is niet mogelijk. XmlDoc comment horen altijd voor een element te staan. Net zoals Attributen voor het element horen te staan waar ze op toepassing van zijn.

[Styxxy]

Zartok schreef op vrijdag 16 augustus 2013 @ 13:33:
Je verliest het niet, maar alles schuift een plekje door, voor IntelliSense is het dan immers hetzelfde als dat ze eronder zouden staan, waardoor het commentaar bij de verkeerde variabele komt te staan. Nou vond ik na googlen dat je cref kan gebruiken om het op een andere plek te zetten, maar dat lijkt alleen voor classes te gelden en niet voor variabele declaraties binnen een class

C#:

///<summary cref="rawData">commentaar</summary>

werkt voor de class rawData, maar niet voor de variabele rawData binnen een class. Maar ik vroeg me af of iemand wist of je iets vergelijkbaars toe kan passen voor variabelen, dat kon ik namelijk niet vinden.

Dat is dus een reden om het niet te doen. Waarom zou je de XML doc bij een verkeerd element willen zetten? Werkt enkel maar verwarrend voor anderen die jouw code willen gebruiken.

[Zartok]

Woy schreef op vrijdag 16 augustus 2013 @ 13:50:
[...]

Heel simpel antwoord: Nee is niet mogelijk. XmlDoc comment horen altijd voor een element te staan. Net zoals Attributen voor het element horen te staan waar ze op toepassing van zijn.

Duidelijk, helaas pindakaas voor mij dan.

Styxxy schreef op vrijdag 16 augustus 2013 @ 13:56:
[...]

Dat is dus een reden om het niet te doen. Waarom zou je de XML doc bij een verkeerd element willen zetten? Werkt enkel maar verwarrend voor anderen die jouw code willen gebruiken.

Ik wil ook niet verkeerde elementen erbij zetten, wil ze enkel op een andere plek hebben. Nu dus kiezen voor locatie of intellisense.

Dank u allen, voor het meedenken/antwoord geven. @modjes, sorry dat ik hem eerst verkeerd zette, maar van mij mag er nu een slotje op, ok

[Woy]

Zartok schreef op vrijdag 16 augustus 2013 @ 14:15:
[...]
Dank u allen, voor het meedenken/antwoord geven. @modjes, sorry dat ik hem eerst verkeerd zette, maar van mij mag er nu een slotje op

Slotjes gaan alleen op topics die niet aan de eisen voldoen, niet als ze opgelost zijn, misschien heeft iemand later immers nog wel wat toe te voegen.

[Caelorum]

Zartok schreef op vrijdag 16 augustus 2013 @ 14:15:
[...] Ik wil ook niet verkeerde elementen erbij zetten, wil ze enkel op een andere plek hebben. Nu dus kiezen voor locatie of intellisense. [...]

Gewoon kiezen voor de standaard/gangbare manier. Anders ga je je alleen maar kapot ergeren als je eens code van andere ziet.

[Zartok]

Caelorum schreef op vrijdag 16 augustus 2013 @ 14:23:
[...]

Gewoon kiezen voor de standaard/gangbare manier. Anders ga je je alleen maar kapot ergeren als je eens code van andere ziet.

het is een hobby projectje, dus ik hoef geen rekening te houden met anderen die het zien. Standaard gebruikte ik al geen Intellisense voor variabelen in de class, maar enkel voor functies zodat ik de input en output duidelijk is. Intellisense voor de variabelen in de class is leuk maar in dit geval laat ik het achterwege en zet ik het liever op een overzichtelijke manier in de code.

[Woy]

Zartok schreef op vrijdag 16 augustus 2013 @ 14:39:
[...]

het is een hobby projectje, dus ik hoef geen rekening te houden met anderen die het zien. Standaard gebruikte ik al geen Intellisense voor variabelen in de class, maar enkel voor functies zodat ik de input en output duidelijk is. Intellisense voor de variabelen in de class is leuk maar in dit geval laat ik het achterwege en zet ik het liever op een overzichtelijke manier in de code.

Nee maar als je je dit nu aanleert, ben je het straks ook gewend als je wel rekening moet houden met anderen . Ik zou het gewoon op de juiste manier aanleren.

[Zartok]

Woy schreef op vrijdag 16 augustus 2013 @ 14:46:
[...]

Nee maar als je je dit nu aanleert, ben je het straks ook gewend als je wel rekening moet houden met anderen . Ik zou het gewoon op de juiste manier aanleren.

Maar ik kan natuurlijk niet alles conform een set onbekende richtlijnen maken en daarom kan ik nu dus geen standaard aanhouden, anders dan de visual C# standaard. Maar ik word, met mijn lichte OCD, er gek van als het er tussen staat en daarom pas ik de standaard hier aan ten koste van het gebruik van IntelliSense.

[Woy]

Zartok schreef op vrijdag 16 augustus 2013 @ 15:04:
[...]
Maar ik kan natuurlijk niet alles conform een set onbekende richtlijnen maken en daarom kan ik nu dus geen standaard aanhouden.

Nou is dit natuurlijk geen onbekende richtlijn, maar gewoon de richtlijn die de hele wereld aanhoudt m.b.t. XmlDoc. Als je zo graag comments achter je members wil hebben, maak het dan tenminste gewoon normale comments zodat de intellisense ook niet overhoop gehaald wordt.

[Zartok]

Woy schreef op vrijdag 16 augustus 2013 @ 15:10:
[...]

Nou is dit natuurlijk geen onbekende richtlijn, maar gewoon de richtlijn die de hele wereld aanhoudt m.b.t. XmlDoc. Als je zo graag comments achter je members wil hebben, maak het dan tenminste gewoon normale comments zodat de intellisense ook niet overhoop gehaald wordt.

Dat zei ik toch ook, alleen dan in andere woorden?

Voor alle duidelijkheid, zo heb ik het dus inderdaad opgelost, dat bedoelde ik ook een paar posts terug; of de manier die het allereerste blokje code op deze pagina laat zien of zo:

C#:

public string rawData;      // The raw data that is obtained from the url
public DateTime timeStamp;  // Time and date of the latest acquisition
private element content;    // Acquired information in element format
private bool processed;     // Is the rawData processed to an element
private bool process;       // Should the rawData be processed to an element

@hieronder: De 2 bovenste variabelen zijn enkel public omdat er net wat is uitgesloopt naar een andere class en daarom nog niet op private konden.

[ Voor 7% gewijzigd door Zartok op 16-08-2013 15:45 ]

[farlane]

Ff wachten tot iemand komt vertellen dat je in de hel komt als je public fields maakt die ook nog niet eens op de juiste manier gedocumenteerd zijn....

[Grijze Vos]

Haha farlane, ik heb dit topic 3x open gehad en mijn handen jeukten, maar uiteindelijk dacht ik: why bother, he probably doesn't want to learn.

[RobIII]

farlane schreef op vrijdag 16 augustus 2013 @ 15:32:
Ff wachten tot iemand komt vertellen dat je in de hel komt als je public fields maakt die ook nog niet eens op de juiste manier gedocumenteerd zijn....

Plus dat er geen PascalCasing gebruikt wordt voor public members

[remyblok]

Misschien is dit erg persoonlijk, maar zelf vind ik dat de naamgeving van field veel belangrijker is dan het commentaar.

Private fields zijn enkel geldig in de scope van de Class. Dus als je snapt wat de Class doet zou het logisch moeten zijn waar de fields voor dienen, als ze een juiste naam hebben. Daarnaast als je code leest waarin field worden gebruikt wil ik niet op gaan zoeken wat er met het field bedoelt wordt, maar dit in een oogopslag uit de context (van de Class) kunnen halen.

Zelf zou ik dus gaan voor zoiets:

C#:

private string rawDataFromUrl; 
private DateTime latestAcquisition; 
private element processedData;
private bool isRawDataProcessed; 
private bool mustProcessRawData;

Wat is jullie mening daarover?