Documentation
Onderwerp reikwijdte
Zoeken…
Invoering
Taalfunctie Onderwerpen
Een natuurlijke indeling is eenvoudigweg één onderwerp maken voor elke taalfunctie. Python heeft bijvoorbeeld:
- Klassen
- functies
- generatoren
- decorateurs
- . . .
Het nadeel is dat functies behoorlijk ingewikkeld kunnen zijn en het is gemakkelijk om veel meer voorbeelden te bedenken dan logisch zijn voor een enkele pagina. Classes heeft bijvoorbeeld 16 voorbeelden. Sommige daarvan kunnen waarschijnlijk worden verplaatst naar andere onderwerponderwerpen, zoals Overerving, Eigenschappen, Methoden, enz.
Handtas Onderwerpen
Sommige onderwerpen zijn losjes bijbehorende voorbeelden onder een thema, zoals C # 6.0-functies en veelvoorkomende valkuilen . Over het algemeen is deze stijl van onderwerp afgeraden omdat voorbeelden per onderwerp beperkt waren, omdat er geen natuurlijke plek is om te stoppen met het toevoegen van inhoud.
Het is waarschijnlijk beter om de voorbeelden naar een ander onderwerp te verplaatsen (misschien voor taalfuncties ). Ik heb dit niet zien gebeuren, maar het is mogelijk dat deze onderwerpen worden omgezet in een meta-onderwerp dat een of twee voorbeelden bevat die grotendeels uit links naar andere onderwerpen of voorbeelden bestaat:
Perl tips en trucs
- Parseer XML niet met een regex! Gebruik een XML-parsmodule .
- Als je hele blokken code wilt becommentariëren, gebruik dan een POD-commentaarblok .
- . . .