Este es el comando sdfget que se puede ejecutar en el proveedor de alojamiento gratuito de OnWorks utilizando una de nuestras múltiples estaciones de trabajo en línea gratuitas, como Ubuntu Online, Fedora Online, emulador en línea de Windows o emulador en línea de MAC OS.
PROGRAMA:
NOMBRE
sdfget - Utilidad de extracción de documentación
PROPÓSITO
sdfget extrae la documentación incrustada en el código fuente.
USO
uso: sdfget [-h [ayuda]] [-o [out_ext]]
[-l [log_ext]] [-O [out_dir]]
[-f nombre_archivo_formato] [-g [get_rule]]
[-r [rpt_file]] [-s alcance] [-i]
[-v [detallado]] archivo ...
propósito: extraer documentación incrustada en el código fuente
versión: 2.000 (SDF 2.001)
Las opciones son:
Opción Descripción
-h muestra ayuda sobre opciones
-o extensión de archivo de salida
-l extensión del archivo de registro
-O salida al directorio del archivo de entrada (o explícito)
-f nombre de archivo para usar al formatear la salida
-g regla para usar para obtener documentación
-r archivo de informe
-s alcance de la documentación a extraer
-i solo líneas de salida no extraídas
-v modo detallado
DESCRIPCIÓN
La opción -h proporciona ayuda. Si se especifica sin un parámetro, una breve descripción
de cada opción se muestra. Para mostrar los atributos de una opción, especifique la opción
letra como parámetro.
De forma predeterminada, la salida generada pasa a la salida estándar. Para dirigir la salida a un archivo por entrada
archivo, use la opción -o para especificar una extensión para los archivos de salida. Si la opción -o es
especificado sin un parámetro, una extensión de out se supone.
Asimismo, los mensajes de error pasan a error estándar de forma predeterminada. Utilice la opción -l para crear una
archivo de registro por archivo de entrada. Si la opción -l se especifica sin un parámetro, una extensión
of log se supone.
De forma predeterminada, los archivos de registro y de salida generados se crean en el directorio actual. Utilizar el
-O opción para especificar un directorio de salida explícito. Si la opción -O se especifica sin
un parámetro, se utiliza el directorio del archivo de entrada.
La opción -f se puede utilizar para especificar un nombre de archivo que se utilizará al formatear la salida. Este es
útil cuando el texto proviene del flujo de entrada estándar.
Las obtener-regla designa el formato de la documentación incrustada que se extraerá. Todos
Las reglas de obtención definidas actualmente asumen que la documentación está en bloques de comentarios en uno de los
siguientes formatos:
>> section_title1 ::
texto de la sección 1, línea 1
texto de la sección 1, línea ..
>> section_title2 ::
texto de la sección 2, línea 1
texto de la sección 2, línea ..
>> FIN ::
>> section_title3 :: texto de la sección 3
La primera forma es la más utilizada. En este formato, el texto de una sección se extiende hasta
el final del "bloque de comentarios" actual o el comienzo de la siguiente sección, lo que ocurra
primero. La segunda forma (es decir, especificar explícitamente dónde termina la sección) es útil si
desea agregar algunos comentarios normales (es decir, no documentación) que no desea
extraído. Si el texto es breve, se puede utilizar la tercera forma. Independientemente del formato, si
se encuentra una sección que ya está definida, el texto de la sección se concatena en
el texto existente. Esto permite especificar la documentación de cada entidad.
inmediatamente arriba de donde está definido en el código fuente.
La opción -g especifica la obtener-regla usar. Las reglas de obtención disponibles difieren en el prefijo
esperado al principio de cada línea como se muestra a continuación.
Prefijo de regla
Perla #
cpp //
c * o / *
fortran c (con 5 espacios anteriores)
eiffel -
murciélago rem
Dentro del código C, se requiere un espacio final después de los caracteres anteriores. Por otro
idiomas, un espacio final es opcional. Dentro del código FORTRAN, el carácter "c" debe ser
precedido por exactamente 5 espacios. Para otros idiomas, cero o más caracteres de espacio en blanco son
permitido antes de los caracteres de arriba.
Por ejemplo, la documentación incrustada dentro del código C se ve así:
/ * >> Propósito ::
* Esta biblioteca proporciona una interfaz de alto nivel
* a los servicios de red de uso común.
*/
Si no se especifica la opción -g, perl es la regla de obtención predeterminada. Si la opción -g es
especificado sin un parámetro, la extensión en minúsculas del nombre del archivo (o la
formato nombre de archivo si el texto proviene de una entrada estándar) se utiliza para adivinar el
get_rule como se muestra a continuación.
Extensiones de reglas
cpp cpp, c ++, cc, hpp, hpp, h, java, idl
cc
fortran fortran, para, f77, f
eiffel eiffel, ada
murciélago murciélago, cmd
Se puede especificar un nombre de archivo de informe mediante la opción -r. Si el nombre no incluye un
extensión, se asume sdg. Los informes proporcionan un mecanismo para:
· Extracción selectiva de secciones, y
· Reformateo rudimentario (p. Ej. Para SDF)
Si no se especifica ningún informe, todas las secciones se generan en el siguiente formato:
título_sección1
sección_texto1
título_sección2
sección_texto2
Si -r se especifica por sí solo, predeterminado.sdg se supone. Este informe selecciona el conjunto de
secciones (dentro del SDF estándares de documentación) que forman la documentación del usuario y
los formatea en SDF. Los detalles sobre el formato del informe se especifican a continuación. Los informes son
buscado en el directorio actual, luego en el biblioteca estándar directorio dentro de la biblioteca de SDF
directorio.
La opción -s se puede utilizar para especificar el alcance de la documentación que se extraerá. (Esta
es una función experimental y puede cambiar, por lo que la mayoría de los usuarios deben evitar su uso).
La opción -i genera solo aquellas líneas que la regla de obtención no coincide. Esta opcion es
útil para extraer documentos no documentados de un archivo para dar solo el código.
Nota: La opción -r se ignora si se especifica -i.
La opción -v habilita el modo detallado. Esto es útil para ver qué regla se está utilizando para
cada archivo.
EJEMPLOS
Para extraer la documentación del usuario de un SDF aplicación escrita en C ++ (xyz, decir) y
guárdalo en xyz.sdf:
sdfget -gcpp -r -osdf xyz.cpp
LIMITACIONES Y FUTURO INSTRUCCIONES
Sería mejor si la regla de obtención siempre se adivinara a partir de la extensión del nombre de archivo, pero
cambiar el valor predeterminado de perl podría romper los scripts existentes. Por lo tanto, adivinar la regla de obtención
debe habilitarse explícitamente especificando la opción -g sin un parámetro.
Use sdfget en línea usando los servicios de onworks.net
