• Zur Hauptnavigation springen
  • Skip to main content
Web Shaped Logo
  • Blog
  • felix@webshaped.de|+49 (0)176 555 300 74
    Sie möchten Ihr Projekt sofort starten?
  1. Start
  2. Web-Entwicklung
  3. Code dokumentieren leicht gemacht – VS Code Extension Empfehlungen #1

Code dokumentieren leicht gemacht – VS Code Extension Empfehlungen #1

Zuletzt aktualisiert am 10. April 2020Keine KommentareExtensions, Visual Studio Code

Sauberer Code setzt auch eine saubere Dokumentation der geschriebenen Klassen und Funktionen voraus. Um einem die Arbeit etwas angenehmer zumachen, gibt es einige nützliche Extensions für
Visual Studio Code . Hier meine Empfehlungen:

TODO Highlight – Aufgaben im Auge behalten

TODO Highlight mit einem dunklem Theme

Häufig macht man sich Notizen über noch anstehende Aufgaben oder bugs die noch gefixt werden müssen. Wer das direkt im Dokument macht, kann sich diese mit TODO Hightlight hervorheben lassen. Unterstützt werden die Phrasen “TODO:” und “FIXME:”. Die Extension unterstützt dabei helle und dunkle VS Code Themes und kommt mit einigen Einstellungsmöglichkeiten daher.

TODO Hightlight im Marketplace

psioniq File Header – Mehr Infos für dein Dokument

/*
 * File: \Users\me\Development\psioniq\myProject\src\myPrecious.js
 * Project: \Users\me\Development\psioniq\myProject
 * Created Date: Saturday December 31 2016
 * Author: Arthur Bodkin, esq
 * -----
 * Last Modified: Sunday January 01 2017
 * Modified By: Tammy Bodkin
 * -----
 * Copyright (c) 2016 psioniq Global Enterprises, Inc
 */

Wer sein Dokument gerne mit einigen Grundinformationen anfängt, sollte sich vielleicht die “psioniq File Header” Erweiterung angucken. Einfach Strg + Alt + H doppelt drücken und schon generiert sich der file header. Den Inhalt kann man natürlich beliebig in den Einstellungen anpassen.

PSIONIQ File Header im Marketplace

Auto Comment Blocks – Automatische Kommentare

Auto Comment Blocks Demo

Tolle Erweiterung mit der man in einem Rutsch Kommentare schreiben kann. Einfach ein Kommentar beginnen, den Rest macht die Erweiterung.

Auto Comment Blocks im Marketplace

PHP DocBlocker – PHP Code dokumentieren

PHP Code zu dokumentieren war noch nie so einfach. Beginnt man über einer function mit /** ein Kommentar, erstellt PHP DocBlocker selbständig eine Dokumentation.

PHP DocBlocker im Marketplace

SassDoc – dokumentiert deine SASS/SCSS Files

Mit SassDoc dokumentiert Du SASS/SCSS functions und mixins in wenigen Sekunden. Dazu wählst du einfach eine function oder mixin und führst “Add SassDoc” als Befehl aus.

SASSDoc im Marketplace

Document This – dokumentiert Deinen JS Code

Document This Demo

Automatische generierte Javascript Dokumentation für classen, functions und vieles mehr. Die Funktionsweise ist ziemlich simpel, einfach den cursor auf z.B. die function halten und Strg + Alt + D drücken.

Document This im Marketplace
Lass es uns wissen, wenn dir der Beitrag gefällt. Das ist für uns der einzige Weg herauszufinden, ob wir etwas besser machen können.
Moin, ich bin Felix Scholze.

Ich bin Web-Developer und Designer aus Berlin. In diesem Blog möchte ich gerne mein Wissen über Webseiten-Gestaltung und Programmierung weitergeben.

Diese Beiträge könnten dir auch gefallen

#Gutenberg

Gutenberg standard Vollbildmodus deaktivieren – WordPress 5.4

#comment-form

WordPress Comment Form Validierung interaktiv mit JavaScript

#Extensions

Code dokumentieren leicht gemacht – VS Code Extension Empfehlungen #1

#comment-form

Datenschutz Checkbox für WordPress Kommentare ohne Plugin

Leser-Interaktionen

Hat Dir der Beitrag gefallen? Lass uns diskutieren: Antworten abbrechen

Erforderliche Felder sind mit * markiert.

Wenn du möchtest kannst du folgende Tags nutzen:

<a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>

Kontaktieren Sie mich

Webentwickler & Webdesigner aus Berlin.

Berlin-Pankow

felix@webshaped.de
+49(0)176 555 300 74

Folgen Sie mir auf:


Bewerten Sie meine Arbeit auf:

Facebook, Google, Proven Expert

    Datenschutz akzeptieren? *

    * Pflichtfeld

    • Impressum
    • Datenschutz
    • Sitemap