Hier is een stapsgewijze handleiding om een gestructureerde code-documented sjabloon voor Python te maken en automatisch in te voegen in Sublime Text: ### 1. Maak een snippet-bestand aan - Open Sublime Text. - Ga naar **Tools > Developer > New Snippet...**. - Er opent een nieuw venster met een standaard snippet-voorbeeld. ### 2. Invoegcode voor de Python-documented sjabloon Vervang de standaardcode door onderstaande code, die een gestructureerde docstring bevat met secties voor functiebeschrijving, parameters, returnwaarden en voorbeelden: ```xml <snippet> <content><![CDATA[ def ${1:functie_naam}(${2:parameters}): """ ${3:Beschrijving van de functie.} Args: ${4:param_name} (${5:type}): ${6:beschrijving van param_name} ${7:param_name} (${8:type}): ${9:beschrijving van param_name} # Voeg meer parameters toe indien nodig. Returns: ${10:type}: ${11:Beschrijving van de returnwaarde} Examples: >>> ${12:voorbeeld_code} """ ${0:# implementatie} ]]></content> <tabTrigger>pyfuncdoc</tabTrigger> <scope>source.python</scope> <description>Python functie met gestructureerde docstring</description> </snippet> ``` ### 3. Aanpassen van de snippet - Je kunt de `${}` placeholders aanpassen of meer toevoegen. - Bijvoorbeeld, voor meer parameters, voeg extra `${}` secties toe onder Args. - Voor een meer uitgebreide structuur, kun je ook meerdere secties of andere formats gebruiken. ### 4. Opslaan van de snippet - Klik op **File > Save**. - Sla het bestand op in de standaard map voor snippets, bijvoorbeeld: ``` Packages/User/python_function_doc.sublime-snippet ``` - Geef het bestand een herkenbare naam, bijvoorbeeld `python_function_doc.sublime-snippet`. ### 5. Gebruik van de snippet - Open je Python-bestand in Sublime Text. - Typ `pyfuncdoc` en druk op **Tab**. - De gestructureerde template verschijnt, klaar om ingevuld te worden. ### 6. Extra tips - Je kunt de placeholders aanpassen zodat je snel door de secties kunt navigeren met Tab. - Wil je verschillende sjablonen voor verschillende functies of klassen, maak dan meerdere snippets met verschillende `tabTrigger` namen. ### Samenvatting - Maak een nieuwe snippet in Sublime Text. - Plak de bovenstaande XML-code. - Sla op met een herkenbare naam. - Gebruik de trigger (`pyfuncdoc`) om snel je gestructureerde documentatie te genereren. Zo heb je een gestandaardiseerd en gemakkelijk in te vullen template voor Python-functies!

Hier is een complete handleiding voor het maken en gebruiken van een gestructureerde documentatiesjabloon voor Python in Sublime Text: ## Stap 1: Sjabloonbestand aanmaken 1. Open Sublime Text 2. Ga naar `Tools > Developer > New Plugin` 3. Verwijder de bestaande inhoud en plak deze code: ```python import sublime import sublime_plugin import datetime class PythonDocstringCommand(sublime_plugin.TextCommand): def run(self, edit): # Haal huidige datum op current_date = datetime.datetime.now().strftime("%d-%m-%Y") # Documentatiesjabloon template = f'''""" FUNCTIEBESCHRIJVING: [Korte beschrijving van de functie] PARAMETERS: param1 (type): Beschrijving van parameter 1 param2 (type): Beschrijving van parameter 2 RETURNWAARDEN: type: Beschrijving van returnwaarde VOORBEELD: >>> voorbeeld_aanroep() verwacht_resultaat AUTEUR: [Jouw naam] DATUM: {current_date} """ ''' # Voeg sjabloon in op cursorpositie for region in self.view.sel(): if region.empty(): self.view.insert(edit, region.begin(), template) ``` 4. Sla het bestand op als `python_docstring.py` in de map: - Windows: `%APPDATA%\Sublime Text\Packages\User\` - Mac: `~/Library/Application Support/Sublime Text/Packages/User/` - Linux: `~/.config/sublime-text/Packages/User/` ## Stap 2: Snelkoppeling instellen 1. Ga naar `Preferences > Key Bindings` 2. Voeg deze binding toe in de rechterkolom (gebruikerskeybindings): ```json { "keys": ["ctrl+shift+d"], "command": "python_docstring", "context": [ { "key": "selector", "operator": "equal", "operand": "source.python" } ] } ``` ## Stap 3: Snippet alternatief (optioneel) Maak een snippet voor meer controle: 1. Ga naar `Tools > Developer > New Snippet` 2. Gebruik deze code: ```xml <snippet> <content><![CDATA[ """ FUNCTIEBESCHRIJVING: $1 PARAMETERS: $2 RETURNWAARDEN: $3 VOORBEELD: >>> $4 $5 AUTEUR: ${6:[Jouw naam]} DATUM: ${7:[datum]} """ ]]></content> <tabTrigger>docpy</tabTrigger> <scope>source.python</scope> <description>Python Documentatie Sjabloon</description> </snippet> ``` 3. Sla op als `python_docstring.sublime-snippet` in dezelfde User map ## Gebruik: 1. **Met snelkoppeling**: Plaats cursor waar je documentatie wilt en druk `Ctrl+Shift+D` 2. **Met snippet**: Typ `docpy` en druk `Tab` ## Voorbeeld gebruik in Python: ```python def bereken_gemiddelde(getallen): """ FUNCTIEBESCHRIJVING: Bereken het gemiddelde van een lijst getallen PARAMETERS: getallen (list): Lijst met numerieke waarden RETURNWAARDEN: float: Het gemiddelde van de getallen VOORBEELD: >>> bereken_gemiddelde([1, 2, 3, 4, 5]) 3.0 AUTEUR: Jan Jansen DATUM: 15-11-2024 """ if not getallen: return 0 return sum(getallen) / len(getallen) ``` ## Aanvullende tips: - **Aanpassen**: Wijzig de sjabloon naar wens door het `.py` of `.sublime-snippet` bestand te bewerken - **Meer secties**: Voeg secties toe zoals `UITZONDERINGEN`, `NOTITIES`, etc. - **Auto-completion**: De snippet versie ondersteunt tab-navigatie tussen velden Deze setup zorgt voor consistente, professionele documentatie in al je Python projecten!