Ik heb voor het overzicht even een helpfile gemaakt van de componenten, veel plezier ermee! www.nldelphi.com/forumfiles/nldtranslate.chm
Ik heb voor het overzicht even een helpfile gemaakt van de componenten, veel plezier ermee! www.nldelphi.com/forumfiles/nldtranslate.chm
Marcel
De OpenXML documentatie hoeft er niet bij , en ik mis eigenlijk de kracht van het helpbestand: de omschrijvingen van de properties/functies. Uiteraard verwacht ik niet dat je dit allemaal gaat doen, ik was zelf ook al bezig mbv 'Delphi Component Help Builder' (of iets dergelijks, ben 'm even kwijt na format), die maakt de help file exact hetzelfde als Borland, wat wel handig is op zich. Maar als referentie is dit al zeker leuk
Qui custodiet ipsos custodes
Die omschrijvingen staan er wel zeker, kijk maar bij TNLDTranslateUndo. Uit de helpfile van BDoc:Door de opbouw van de BDoc documentatie wordt een project, of verzameling van projecten, al snel overzichtelijk in beeld gebracht. Toch zal het altijd nodig zijn om extra beschrijvingen bij de diverse items toe te voegen, bijvoorbeeld een beschrijving van een classe of property. Deze beschrijvingen worden door veel programmeurs al standaard als commentaar in de code geplaatst.
BDoc maakt gebruik van deze standaarden door dit commentaar in de documentatie mee te nemen. Om commentaar als beschrijving van een item mee te nemen is het voldoende om dit commentaar steeds voor het betreffende item te plaatsen. De volgende beschrijvingen worden dan meegenomen:
Unit: commentaar bovenin de unit wordt als beschrijving bij de unit geplaatst
Classe: commentaar boven een classedefinitie wordt als beschrijving bij de classe geplaatst
Interface: commentaar boven een interfacedefinitie wordt als beschrijving bij de interface geplaatst
Property: commentaar boven een property wordt als beschrijving bij de property geplaatst
Procedure/functie: commentaar boven de implementatie van een procedure/functie wordt als beschrijving bij de procedure/functie geplaatst.
Het commentaar in de units mag tussen commentaarhaken staan ({ } en (* *)), of achter slashes. Er kunnen extra keywords worden aangemaakt voor de index door deze tussen [ ] haken te plaatsen. Een unit met een formuler en een interface komt er dan als volgt uit te zien:
Marcel
De voorbeeldcode die hierbij hoort:Code:{ Deze unit bevat een demonstratieformulier. Het commentaar op deze plaats wordt bij de unit weergegeven } unit DemoFormU; interface uses Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs; type { Demonstratieinterface om de plaats voor [documentatie] van interfaces aan te geven } IDemoInterface = interface(IUnknown) procedure DemoProcedure; end; { Dit demonstratieformulier bevat een aantal methods en properties. Het formulier is gemaakt om de verschillende manieren van [documenteren] te laten zien } TDemoForm = class(TForm, IDemoInterface) private FProp: string; procedure DemoProcedure; public { Demonstratieproperty om de plaats voor [documentatie] van properties aan te geven } property DemoProp: string read FProp write FProp; end; implementation {$R *.DFM} { TDemoForm } { Demonstratieprocedure om de plaats voor documentatie van procedures en functies aan te geven } procedure TDemoForm.DemoProcedure; begin end; end.
Marcel
Nadeel is dat mijn source in ieder geval niet alles omschrijft omdat ik niet voorbereid was op BDoc en ik al helemaal geen licentie heb . Mijn doel was om het grootste deel te automatiseren door automatisch topics aan te maken voor componenten/properties, maar dan wel zelf de omschrijvingen in de help file te zetten, samen met examples e.d., zo blijft de source enigzins netjes en kan je toch veel info in de help file proppen
Qui custodiet ipsos custodes
Ik hou er niet van om externe documentatie te maken of bij te houden. Ik ken mezelf goed genoeg om te weten dat ik dat toch vergeet bij te houden. Vandaar dat ik alle documentatie in de source doe en de helpfile automatisch genereer. Vandaar dat ik BDoc ook heb geschreven.
Marcel
There are currently 2 users browsing this thread. (0 members and 2 guests)
Bookmarks