En la codificació, els comentaris són una de les poques maneres de preservar els pensaments per al futur. Us poden ajudar a veure fragments de codi i poden ser útils per al proper desenvolupador que intentarà entendre el que heu escrit dies abans. Si utilitzeu Visual Studio Code (VS Code), no cal escriure delimitadors de comentaris incansablement cada vegada. VS Code té una funció de drecera integrada que estalvia segons (i fins i tot minuts) del vostre temps.
La drecera de comentaris Quick VS Code
Per als que tinguin pressa, aquí teniu el vostre bitllet d'or:
són jocs de wii compatibles amb switch
- Per a un comentari d'una sola línia, utilitzeu la combinació de tecles Ctrl + / a Windows o Linux o Cmd + / a un Mac.
,
- Per a un comentari de bloc, utilitzeu Maj + Alt + A a Windows o Linux o Maj + Opció + A en un Mac.
,
- Per comentar el codi, podeu prémer Ctrl + K + C a Windows o Cmd + K + U a Mac.
,
La majoria dels programadors comenten molt. I no es tracta només de deixar comentaris reals, sinó que potser el més important és que comentareu i deixareu de comentar el codi. Això és viable per provar, experimentar i depurar.
Hi ha dreceres per fer-ho més agradable. Agilien la navegació i l'alteració, i us permeten alternar els comentaris sense interrompre l'impuls de la codificació.
Comentaris més enllà dels bàsics
Tot i que les dreceres bàsiques són un veritable regal, hi ha molt més per comentar VS Code. Anem a aprofundir:
Commuta els comentaris
La millor part de les dreceres de comentaris de VS Code és la seva funció de commutació. No cal que us trobeu i elimineu cada marcador de comentari manualment si canvieu d'opinió (o durant la depuració). En comptes d'això, només feu servir les mateixes dreceres. Amb les mateixes combinacions de tecles, podeu canviar ràpidament entre codi comentat i no comentat per mantenir-vos organitzat quan més ho necessiteu.
Comentant diverses línies
Si necessiteu silenciar un bloc llarg de codi o deixar un comentari extens i detallat, no voleu passar temps afegint comentaris línia per línia. Així, en lloc d'això, podeu seleccionar les línies que voleu desactivar i utilitzar la drecera de comentaris per permetre que VS Code introdueixi comentaris a cada línia.
Comentaris imbricats
De vegades, inserir comentaris en un bloc de codi pot provocar resultats i errors inesperats si els delimitadors no coincideixen molt bé. Aquí és on Intellisense de Visual Studio Code us pot ajudar. Ajustarà el format dels comentaris fins i tot dins d'un bloc ja comentat, de manera que no hi haurà conflictes amb els comentaris imbricats.
Extensions als comentaris de Supercharge
VS Code és un editor de codi obert que serveix com a plataforma perquè els desenvolupadors facin la seva millor extensió. El mercat està ple d'extensions per oferir-vos més potència i utilitat quan comenteu:
Millors comentaris
Els comentaris poden semblar una part petita i opcional de la codificació, però hi ha tantes maneres creatives d'utilitzar els comentaris. El Millors comentaris L'extensió us ajuda a afegir propòsit i claredat als comentaris sobre els quals espolseu classificant-los en alertes, consultes, tasques pendents i altres categories. I això és tot amb l'avantatge afegit de la codificació de colors per millorar la visibilitat i l'organització. Els vostres comentaris es converteixen en punts de referència i separadors que fan que el vostre codi sigui més net i accessible.
desactiveu els comentaris a la pàgina de Facebook
Àncores de comentaris
Àncores de comentaris mantenir-vos a terra en el vostre codi amb punts que distingeixen seccions o punts essencials. Si proveu aquesta extensió, us permetrà trobar ràpidament notes i observacions precises. Si el vostre projecte és ampli i el vostre codi s'amuntega i és difícil de seguir, això pot fer-lo molt més digerible.
Polacode
Polacode transforma el vostre codi i comentaris en imatges visualment interessants, fàcilment llegibles i compartibles que són perfectes per a les xarxes socials. Us permet canviar la mida, codificar els colors, canviar el fons i molt més. Us beneficieu d'una major llegibilitat i qualsevol company d'equip pot col·laborar i compartir informació molt més fàcil.
Per què comentar?
Comentar no és només una casella per marcar o alguna tasca opcional que fan les persones amb paraules; és una part integral de la codificació. Aquestes són algunes de les raons per això:
Claredat
Els codificadors busquen fer intel·ligible allò intractable. Escriure codi que funciona de vegades pot ser més senzill que escriure codi fàcil d'entendre i seguir. Els comentaris són la brúixola del desenvolupador: una ajuda inestimable per navegar per extensions de codi, siguin lleugers i joves o densos i madurs. És possible que estiguis tractant amb algorismes enrevessats o processos empresarials arcanics. En qualsevol cas, els comentaris proporcionen una presa familiar en un mar de complexitat.
Col·laboració
Els comentaris són útils quan sou un desenvolupador en solitari. Però són necessaris quan es treballa en equip si voleu que el vostre projecte avanci. Dins d'un esforç col·laboratiu, els comentaris permeten que diversos desenvolupadors col·laborin perfectament fins i tot quan no interactuen. Els membres de l'equip poden explicar el codi i compartir els seus processos de pensament i raonament darrere de les seves decisions. Això serveix de pont que permet que tothom estigui en la mateixa pàgina tant amb el projecte com amb els altres.
Depuració
Si us trobeu tornant a visitar el codi antic o intentant depurar alguna cosa que us desconcerta, els comentaris es converteixen en la vostra gràcia salvadora. Mantenen un registre de la vostra lògica i procés de pensament passat que us pot indicar la possible lògica defectuosa i us pot portar de nou als orígens de l'error. Amb aquest recordatori d'on havíeu estat en el passat, podeu revertir els canvis problemàtics, optimitzar el codi antic i tornar al bon camí.
com cancel·lar una subscripció a Netflix
Consells per fer comentaris efectius
Ara ja sabeu com utilitzar les dreceres de comentaris, tenir algunes extensions addicionals convenients i comprendre els escenaris quan comentar és el més útil. Tot el que et queda és tenir en compte algunes bones pràctiques de comentaris i t'hauràs graduat del curs de comentaris de codificació.
Sigues concís
Hi ha habilitat per deixar enrere comentaris concisos i fàcils de digerir. Deixeu-hi prou per donar-vos la idea correcta al vostre futur o als membres del vostre equip, però no tant per ser aclaparador. Cada paraula del teu comentari ha de tenir un propòsit i ajudar a construir el missatge que estàs intentant transmetre. Si el vostre comentari és massa breu, pot ser que no transmeti el seu missatge, però si és massa llarg, és més probable que ho us ho desitgeu o us confongueu en el futur.
Eviteu comentaris obvis
La rellevància hauria de ser la vostra principal preocupació per crear codi clar i entenedor. Si ja escriviu el vostre codi perquè el seu significat sigui obvi, no cal esmentar res que es pugui veure a primera vista. Deixa que el codi parli sempre que pugui i fes servir comentaris per afegir context addicional o oferir noves perspectives.
Utilitzeu els comentaris per a 'Per què', no 'Què'
El vostre codi exposa els fets del que està passant. Però els comentaris poden explicar una història més profunda. Transmeten les motivacions i els processos de pensament darrere de les vostres decisions. Per què vas triar aquest algorisme sobre un altre? Quines eren les trampes a tenir en compte? Potser heu provat algun codi que molts recomanarien, però no va funcionar o no funcionava bé. Podeu transmetre molt més que simples instruccions amb comentaris ben elaborats.
Deixant un comentari
La funció de comentaris de VS Code podria ser més que una comoditat. Si n'aprofiteu al màxim, la diferència en la navegabilitat i la comprensió de la vostra base de codi pot ser enorme. Complementat amb extensions intel·ligents i una estratègia exhaustiva, aviat podreu crear un codi ben documentat que es llegeix com una obra mestra.
Deixes molts comentaris per explicar el teu codi? O utilitzeu sobretot els comentaris per excloure el codi trencat o experimental del depurador? Expliqueu-nos la vostra història als comentaris a continuació. Han vingut per quedar-se.
