2008-12-22 12 views
2

Existe-t-il des conventions pour la mise en forme de la sortie de la console à partir d'une application de ligne de commande pour des raisons de lisibilité et de cohérence? Par exemple, indiquez-vous des sous-informations, quand imprimez-vous une ligne vide, si jamais, comment devriez-vous accentuer les déclarations importantes.Formatage de la sortie de la console

J'ai trouvé que la sortie peut rapidement dégénérer en un flou chaotique. Je suis intéressé à entendre parler de ce que les autres font. Vraiment c'est pour le logiciel embarqué qui crache le statut de débogage sur un terminal, mais c'est à peu près comme une application de console, et j'ai pensé que tout le monde serait plus familier avec cela. Merci pour l'instant.

Répondre

1

je distinguer deux types de programmes:

-vous imprimer des informations qui pourraient être utilisé par un script (à savoir qu'il devrait être analysable)? Puis définissez un format assez strict et n'utilisez que cela (par exemple des séparateurs de champs fixes).

Imprimez-vous des informations qui n'ont pas besoin d'être analysées par un script (ou existe-t-il déjà un autre format analysable par script)? Ensuite, écrire ce qui est naturel:

Mes suggestions:

  • écrire afin que vous souhaitez lire
  • sous-informations tiret 2 ou 4 places, certainement pas plus
  • blocs distincts de information par une ligne vide au plus
  • respecter la variable d'environnement COLUMN (et ROWS si elle s'applique à votre sortie).
1

Si c'est pour un environnement * nix, alors je vous recommande de lire Basics of Unix Philosophy. Ce n'est pas spécifique à la sortie, mais il existe quelques bonnes directives pour les programmes de ligne de commande en général.

Attendez que la sortie de chaque programme devienne l'entrée d'un autre programme, encore inconnu. Ne pas encombrer la sortie avec des informations superflues. Évitez les formats d'entrée en colonnes ou binaires stricts. N'insistez pas sur la saisie interactive.

Questions connexes