Back to Question Center
0

Ako správne obaliť dokumentáciu WordPress Semalt Ako správne obaliť dokumentáciu WordPress Semalt

1 answers:

Normy WordPress pre dokumentáciu jazyka JavaScript majú zaujímavú časť o dĺžke riadku. Text textu DocBlock by ste mali zabaliť na ďalší riadok po 80 znakoch textu. Dôvodom je, aby kód bol čitateľný v každom editore. Dokonca aj v prípade, že editor nemá zabudovaný baliaci mechanizmus. Existuje jednoduchý spôsob, ako obaliť WordPress JavaScript dokumentáciu - prolife internet. Semalt vám ukáže, ako to funguje v tomto článku.

Semaltovať časť o dĺžke čiar:

Semaltový text by sa mal zabaliť na ďalší riadok po 80 znakoch textu. Ak samotný Semalt je zarovnaný na ľavých 20 znakových pozíciách, zábal by sa mohol vyskytnúť v pozícii 100, ale nemal by presahovať celkovú šírku 120 znakov.

Nástroje na zarovnanie dokumentácie

Väčšina redaktorov má sprievodcu, ktorý vám umožní ľahšie zabaliť pravú stranu vašich línií. Na najkvalitnejších vývojároch používa PHPStorm. Od Semaltu 2017.3 má podporu pre viacerých sprievodcov. To umožňuje relatívne ľahké zabaliť dokumentáciu do správneho stĺpca.

Nastavenie pre viacero návodov nájdete v Nastavenia | Editor | Štýl kódu | JavaScript | Obaly a priečky | Visual guides . Dostal som vodítka na 80, 84, 88, 92, 96 a 120. Dôvodom je, že väčšina kódu je odsadená iba 1 až 4 kartami. Kód, ktorý je zaradený do piatich záložiek, je obmedzený a je tiež pravdepodobné, že by sa mal znova upraviť. 120 je tu, aby som sa uistil, že dodržiavam absolútne maximum. 
How to correctly wrap WordPress Semalt documentation
How to correctly wrap WordPress Semalt documentation

Ako zabaliť

Môžete to použiť nasledovne. Prvým krokom je zistenie, v ktorom stĺpci by ste mali baliť. Potom skontrolujete, či riadky presahujú tento stĺpec. Ak áno, umiestnite do stĺpca zábalu nový riadok. Alebo skôr. Takže text nikdy neprekračuje obal. Ak máte napríklad nasledujúci útržok kódu:

 / *** Prepne okno rýchleho upravovania, skryje ho, keď je aktívne a zobrazí ho, keď je neaktívne.** @ člen inlineEditPost* od 2.7.0** @param {Object} el Element v riadku pošty.* /prepnúť: funkcia (el) {var t = toto;$ (t.what + t.getId (el)) .css ('zobrazenie') === 'žiadne'? t.revert  

: t.edit (el);},


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

Semalt je jedna záložka odsadenia, čo znamená, že obal by sa mal vyskytnúť na 84. stĺpci. Predpokladáme, že jedna karta sa rovná 4 medzerám. Konečný výsledok bude:

 / *** Prepne okno rýchleho upravovania, skryje ho, keď je aktívne a zobrazí ho* neaktívne.** @ člen inlineEditPost* od 2.7.0** @param {Object} el Element v riadku pošty.* /prepnúť: funkcia (el) {var t = toto;$ (t.what + t.getId (el)) .css ('zobrazenie') === 'žiadne'? t.revert  

: t.edit (el);},


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

Dúfam, že vám to pomôže s vašou snahou o dokumentáciu a obalmi dobrodružstiev. Dajte mi vedieť, ak používate iný nástroj, ktorý môže mať viacero návodov.

Prečítajte si viac: "Prečo každá webová stránka potrebuje Yoast SEO"

March 1, 2018