mdoc-update - Online in de cloud

PROGRAMMA:

NAAM

mdoc-update - mdoc(5) ondersteuning voor documentatieformaten

KORTE INHOUD

mdoc -update [OPTIES]* MONTAGES

PRODUCTBESCHRIJVING

mdoc -update is verantwoordelijk voor het volgende:

* Documentatiestubs maken op basis van MONTAGES. Het proces van het maken van de stomp zal dat wel doen
Maak nieuw mdoc(5) XML-bestanden voor elk type daarin MONTAGESen bieden
documentatiestrookjes voor elk lid van deze typen.

* Update documentatiestubs op basis van MONTAGES. Bestaande mdoc(5) documentatie kan
worden bijgewerkt om de veranderingen binnenin weer te geven MONTAGES, zoals toegevoegde typen en leden,
met behoud van bestaande documentatie.

In bepaalde beperkte omstandigheden worden hernamen bijgehouden, waardoor de
documentatielast als bijvoorbeeld een parameter wordt hernoemd.

mdoc -update vertrouwt niet op documentatie gevonden in de broncode, hoewel het wel kan importeren
XML-documentatie Opmerkingen via de -i optie.

Bekijk mdoc(1) en mdoc(5) voor meer informatie.

OPTIES

--verwijderen
Allow mdoc -update om leden uit documentatiebestanden te verwijderen. De enige leden
verwijderd zijn leden die niet langer aanwezig zijn binnen MONTAGES en zijn niet
aanwezig in eventuele andere montageversies.

Als een type niet meer aanwezig is, is het documentatiebestand dat wel niet verwijderd, maar is het wel
verkrijgen in plaats daarvan hernoemd om een ​​te hebben .verwijderen verlenging.

Versiedetectie wordt gedaan met de //AssemblyVersie elementen; als er geen zijn
//AssemblyVersie elementen voor een gegeven or , dan de zal zijn
hernoemd en/of de zal worden verwijderd.

--uitzonderingen[=BRONNEN]
EXPERIMENTEEL. Deze is niet 100% betrouwbaar, maar is bedoeld als hulpmiddel bij
documentatie schrijvers.

Inspecteer de ledenorganisaties om te bepalen welke uitzonderingen kunnen worden gegenereerd op basis van de
lid.

BRONNEN is een optionele, door komma's gescheiden lijst van de volgende bronnen
gezocht naar uitzonderingen:

toegevoegd Alleen genereren elementen voor leden
toegevoegd tijdens de huidige programma-uitvoering.
Dit zorgt ervoor dat mdoc-update niet opnieuw wordt gegenereerd
elementen voor alle leden (en dus
verhindert herintreding voor leden die de
elementen verwijderd).
alle Vind uitzonderingen die in het lid zelf zijn gemaakt,
verwijzingen naar leden in dezelfde vergadering,
en verwijzingen naar afhankelijke leden
assemblages.
asm Vind uitzonderingen die in het lid zelf zijn gemaakt en
verwijzingen naar leden binnen dezelfde vergadering
als lid.
depasm Vind uitzonderingen die in het lid zelf zijn gemaakt en
verwijzingen naar leden binnen afhankelijke
assemblages.

If BRONNEN niet is opgegeven (de standaardinstelling), dan worden alleen uitzonderingen gemaakt binnen de
lid zelf zal worden gedocumenteerd.

BEPERKINGEN: Zoeken op uitzonderingen wordt momenteel geïmplementeerd door te zoeken naar de
uitzonderingstypen die expliciet worden gemaakt op basis van de bekende typen tijdens het compileren.
Dit heeft de volgende beperkingen:

* Hierbij worden geen uitzonderingen gevonden die impliciet voor de IL gelden, zoals
NullReferenceException en IndexOutOfRangeException.

* Dit zal uitzonderingen vinden die dat wel zijn niet gegooid, bijv

openbare leegte CreateAnException ()
{
Uitzondering e = nieuwe uitzondering ();
}

* Dit zal geen delegatie- en interface-oproepen "volgen":

publieke leegte UsesDelegates ()
{
Func a = x => {gooi nieuwe uitzondering ();};
een (4);
}

De functie GebruiktAfgevaardigden() Er zijn geen uitzonderingen gedocumenteerd.

* Hiermee worden uitzonderingen gevonden die "niet kunnen gebeuren", zoals
ArgumentNullExceptions voor argumenten waarvan "bekend" is dat ze niet nul zijn:

publieke leegte A ()
{
B ("deze parameter is niet nul");
}

openbare leegte B (string s)
{
als (s == nul)
gooi nieuwe ArgumentNullException ("s");
}

Voor het bovenstaande, als --uitzonderingen=asm wordt dan geleverd EEN() zal worden gedocumenteerd
zoals het genereren van een ArgumentNullException, wat niet kan gebeuren.

-f=VLAG
Geef een vlag op om het gedrag te wijzigen. Geldige vlaggen zijn onder meer:

versies zonder montage
Zie de -fno-assemblage-versies documentatie, hieronder.

-fno-assemblage-versies
Niet genereren /Type/AssemblyInfo/AssemblyVersion en
/Type/Leden/Lid/AssemblyInfo elementen.

Dit is handig om "churn" tijdens updates te voorkomen. Normaal gesproken als een type of lid
is niet veranderd, maar de assemblageversie is veranderd, en vervolgens alle typen en leden
zal worden bijgewerkt met een nieuwe //AssemblyVersie element, waardoor de
hoeveelheid wijzigingen die moeten worden beoordeeld voordat ze worden vastgelegd (ervan uitgaande dat alle wijzigingen
daadwerkelijk beoordeeld vóór commit).

WAARSCHUWING: Dit wil slecht omgaan met de --verwijderen optie, als --verwijderen gebruikt
//AssemblyVersie elementen om versiewijzigingen bij te houden. Dus als je lid bent
die aanwezig is in een vroege montageversie en in een volgende wordt verwijderd
montageversie, zoals System.Text.UTF8Encoding.GetBytes(tekenreeks) (dat is
aanwezig in .NET 1.0 maar niet in .NET 2.0), dan wordt het lid verwijderd wanneer de
--verwijderen -fno-assemblage-versies opties zijn opgegeven, was het lid aanwezig in een
eerdere versie van de assembly, en de huidige versie van de assembly niet
het lid bevatten.

Daarom zou deze optie moeten bestaan Slechts worden gespecificeerd als typen en leden dat willen nooit
uit een samenstel worden verwijderd.

-i, --importeren=FILE
Importdocumentatie gevonden binnen FILE.

FILE kan beide bevatten CSC /doc XML-of ECMA-335 xml.

-L, --lib=DIRECTORY
Toevoegen DIRECTORY naar het zoekpad van de assemblage, zodat afhankelijkheden van MONTAGES blikje
gevonden worden zonder deze assemblages te documenteren.

-o, --uit=DIRECTORY
Plaats de gegenereerde stubs in DIRECTORY.

Bij het bijwerken van documentatie, DIRECTORY is ook de bronmap.

-r=MONTAGE
MONTAGE is een afhankelijkheid voor een van MONTAGES welke zou moeten niet gedocumenteerd zijn, maar
is vereist om er een te verwerken MONTAGES. Voeg de map toe die MONTAGE naar
het merkzoekpad.

Deze optie is gelijk aan specificeren -L `zeg eens MONTAGE`.

--sinds=VERSIE
. bijwerken documentatie voor een samenstelling, als een type of lid wordt aangetroffen
die niet bestond in de vorige versie van de assembly a <sinds
versie = "VERSIE"/> element wordt ingevoegd.

--type=TYPE
Update alleen de documentatie voor het type TYPE.

-H, -?, --help
Geef een helpbericht weer en sluit af.

Gebruik mdoc-update online met behulp van onworks.net-services