Le code informatique
Définition
Le code cité dans un texte doit préserver sa forme exacte tout en restant lisible. Les règles microtypographiques portent sur la police à chasse fixe, les espaces, la casse, les guillemets, la ponctuation environnante et les retours à la ligne.
Police à chasse fixe et blocs de code
Les fragments de code, noms de variables, fonctions ou commandes se composent souvent en chasse fixe. Cela signale que les caractères doivent être lus et copiés tels quels.
Utilisez getUser(), puis lancez npm install.
La chasse fixe signale ce qui se lit et se copie tel quel.
Respect de la casse
La casse du code doit être conservée exactement. Une capitale supprimée ou ajoutée peut transformer le fragment cité et nuire à la copie.
getuser()
ApiKey
getUser()
apiKey
La casse du code fait partie du code.
Espaces dans le code
Les espaces significatifs du code doivent être préservés. Les corrections typographiques automatiques ne doivent pas remplacer, ajouter ou supprimer des espaces dans un fragment technique.
margin
:0 auto;
margin:0 auto;
Le code suit ses propres règles d’espacement, pas celles de la ponctuation française.
Guillemets, apostrophes et corrections automatiques
Dans un fragment de code, les guillemets droits et apostrophes droites doivent rester tels quels si le langage les exige. Les guillemets typographiques servent au texte, pas au code copiable.
Les ligatures, apostrophes typographiques, substitutions de tirets, capitalisation automatique et espaces insécables peuvent être indésirables dans le code. Les zones de code doivent les neutraliser si nécessaire.
const nom = “Microtipo”;
const id = ‘main’;
const nom = "Microtipo";
const id = 'main';
Guillemets et apostrophes droits : les formes typographiques cassent le code.
—help
font–size
--help
font-size
La correction automatique transforme -- en tiret cadratin : à désactiver pour le code.
Ponctuation autour du code
La ponctuation de la phrase reste en dehors du fragment si elle n’appartient pas au code. On évite d’intégrer par erreur un point final ou une virgule dans un extrait à copier.
CopiezgetUser(),dans votre fichier.
CopiezgetUser()dans votre fichier.
La virgule appartient à la phrase : elle sort du fragment copiable.
Parenthèses et crochets
Les parenthèses, crochets et accolades qui font partie du code doivent être conservés. Ceux qui appartiennent à la phrase doivent rester typographiquement distincts par le contexte.
La fonction getUser() (introduite en v2) renvoie l’utilisateur.
Les parenthèses du code restent dans la chasse fixe ; celles de la phrase, dans le texte.
Retours à la ligne
Un fragment court de code doit rester sur une seule ligne quand c’est possible. Les coupures ne doivent pas séparer un nom, une option, une chaîne ou un opérateur de façon trompeuse.
get
User()
getUser()
Un identifiant ne se coupe jamais.
Markdown et balisage léger
Dans Markdown, certains signes ont une valeur syntaxique. Les astérisques, underscores, crochets, parenthèses et backticks doivent rester placés selon la syntaxe attendue.
* important *
*important*
En Markdown, les signes collent au texte balisé.