language agnostic - Comment composez-vous des éléments de code dans du texte normal?

Translate

Quelle est la meilleure façon de composer une fonction avec des arguments de lisibilité, de concision et de précision? J'ai tendance à mettre des parenthèses vides après le nom de la fonction commefunc(), même s'il existe en fait des arguments pour la fonction. J'ai du mal à inclure les arguments et j'ai toujours l'impression que le paragraphe est lisible.

Des idées sur les meilleures pratiques à cet égard?

This question and all comments follow the "Attribution Required."

Toutes les réponses

Translate

J'adopte généralement cette approche, mais si j'ai l'impression que cela va semer la confusion, j'utiliserai des ellipses comme:myFunction(...)

Je suppose que si j'étais bon, je les utiliseraistoutfois que j'omettais des paramètres d'une fonction dans le texte.

La source
Translate

Je serais simplement un peu plus prudent avec le nom de mes variables et paramètres, la plupart des gens pourront alors deviner beaucoup plus précisément quel type de données vous souhaitez y contenir.

La source