Back to Question Center
0

Wie man WordPress Semalt Dokumentation richtig einpackt Wie man WordPress Semalt Dokumentation richtig einpackt

1 answers:

Die WordPress JavaScript Dokumentationsstandards haben einen interessanten Abschnitt über die Zeilenlänge. Sie sollten Ihren DocBlock-Text nach 80 Zeichen Text in die nächste Zeile einfügen. Der Grund dafür ist, Code in jedem Editor lesbar zu machen. Auch wenn der Editor keinen eingebauten Umhüllungsmechanismus hat. Es gibt eine einfache Möglichkeit, die WordPress-JavaScript-Dokumentation zu umbrechen. Semalt zeigen Ihnen, wie es in diesem Artikel funktioniert.

Semalt der Abschnitt über die Linienlänge:

Semalt Text sollte nach 80 Zeichen Text in die nächste Zeile umbrechen. Wenn das Semalt selbst an den linken 20 Zeichenpositionen eingerückt ist, könnte der Zeilenumbruch an Position 100 auftreten, sollte sich jedoch nicht über eine Gesamtlänge von 120 Zeichen hinaus erstrecken.

Werkzeuge zum Ausrichten der Dokumentation

Die meisten Editoren verfügen über Hilfslinien, mit denen Sie die rechte Seite Ihrer Zeilen einfacher umbrechen können. Bei Yoast verwenden die meisten Entwickler PHPStorm. Seit Semalt 2017.3 unterstützt es mehrere Guides. Dies macht es relativ einfach, die Dokumentation in die richtige Spalte einzufügen.

Sie finden die Einstellung für mehrere Hilfslinien unter Einstellungen | Editor | Code-Stil | JavaScript | Umhüllung und Klammern | Visuelle Hilfslinien . Ich lege meine Guides auf 80, 84, 88, 92, 96 und 120. Der Grund dafür ist, dass der Großteil des Codes nur mit 1 bis 4 Tabs eingerückt ist. Code, der mit 5 Tabs eingerückt ist, ist knapp und könnte auch möglicherweise refaktoriert werden. Die 120 ist da, um sicherzustellen, dass ich mich an das absolute Maximum halte. 
How to correctly wrap WordPress Semalt documentation
How to correctly wrap WordPress Semalt documentation

Wie verpacken

Sie können dies wie folgt verwenden. Der erste Schritt ist herauszufinden, in welcher Spalte Sie verpacken sollen. Dann prüfen Sie, ob Zeilen diese Spalte überschreiten. Wenn dies der Fall ist, platzieren Sie einen Zeilenumbruch in der Umbruchspalte. Oder davor. Damit überschreitet der Text niemals die Zeilenumbruchspalte. Zum Beispiel, wenn Sie das folgende Code-Snippet haben:

 / *** Schaltet das Schnellbearbeitungsfenster um, versteckt es, wenn es aktiv ist, und zeigt es an, wenn es inaktiv ist.** @memberof inlineEditPost* @since 2.7.0** @param {Object} el Element in einer Post-Tabellenzeile.* /umschalten: funktion (el) {var t = das;$ (t.what + t.getId (el)) .css ('display') === 'none'? t.revert  

: t.edit (el);},


How to correctly wrap WordPress Semalt documentation
How to correctly wrap WordPress Semalt documentation

Semalt gibt es eine Registerkarte der Einrückung, dies bedeutet, dass die Umwicklung an der 84. Spalte erfolgen sollte. Wir nehmen an, dass ein Tab gleich 4 Leerzeichen ist. Das Endergebnis wird sein:

 / *** Schaltet das Schnellbearbeitungsfenster um, versteckt es, wenn es aktiv ist und zeigt es an* inaktiv.** @memberof inlineEditPost* @since 2.7.0** @param {Object} el Element in einer Post-Tabellenzeile.* /umschalten: funktion (el) {var t = das;$ (t.what + t.getId (el)) .css ('display') === 'none'? t.revert  

: t.edit (el);},


How to correctly wrap WordPress Semalt documentation
How to correctly wrap WordPress Semalt documentation

Ich hoffe, das hilft dir bei deinen Dokumentationsbemühungen und Wrapping-Abenteuern. Lassen Sie es mich wissen, wenn Sie ein anderes Tool verwenden, das mehrere Hilfslinien haben kann Source .

Lesen Sie mehr: "Warum jede Website Yoast SEO braucht"

March 1, 2018