Necesito documentar el software en el que estoy trabajando actualmente. El software consta de varios lenguajes de programación y scripts que me hicieron pensar. Si aparecen nuevos desarrolladores y necesita arreglar algo, es posible que conozcan Java pero quizás no bash scripting. Sería bueno si hubiera un programa que ayudaría a entender qué¿Hay algún programa que pueda ayudar a entender otro programa?
for f in "[email protected]" ; do
significa. Estaba pensando en algo que crea una página HTML estática con el código más resaltado de sintaxis y si se pasa sobre algo (como el "para"), sería mostrar una ventana emergente con una explicación:
for
aperturas un bucle que itera sobre todos los valores que siguen ain
. En el ciclo, puede acceder a cada valor a través de la variable$f
. El cuerpo del bucle está entredo
ydone
¿Existe ya algo por el estilo?
[EDITAR] Esto es solo un ejemplo. Obtendrá otra ayuda para f
, in
, "[email protected]"
, ;
y do
, es decir, se explicarán todos y cada uno de los elementos de la línea. Los elementos desconocidos (como los nombres de comando) deberían vincularse a Google. Para que pueda entender lo que hace, incluso si le falta algún detalle.
[EDIT2] Soy consciente de que no puede escribir un programa que comprenda qué hace otro programa. Lo que estoy buscando es una herramienta simple que haga "resaltado de sintaxis extendida" en el sentido de que coloreará una expresión y dará una explicación breve lo que significa (más tal vez un enlace a alguna referencia en profundidad).
Esto es para alguien que sabe cómo programar pero que quizás no haya visto alguna construcción oscura antes. Decir
echo "Error" 1>&2
Cada programador fiesta sabe lo que esto significa, pero un desarrollador de Java podría ser confundido por el 1>&2
a pesar del hecho de que pueden adivinar que echo
== System.out.println
. Un simple "Redirects stdout to stderr" aclarará las cosas y dará ese instante "AHA!" lo que les permite mantenerse en su línea de pensamiento actual.
Para alguien que no conoce bash, la parte difícil no es 'for', es' $ @ '. – mouviciel
Esto es solo un ejemplo. Obtendrá otra ayuda para 'f',' in', '" $ @ "', ';' y 'do', es decir, todos y cada uno de los elementos de la línea deberían explicarse. Para que pueda entender lo que hace, incluso si le falta algún detalle. –
+1 Buena pregunta. : D Hay programas que pueden entender otros programas. Se llaman intérpretes/compiladores. Pero generalmente cada uno de ellos entiende un solo idioma. –