2012-03-12 21 views

Respuesta

6

No estoy seguro de que \ref o \link puedan hacer esto. Sin embargo, si pudieran, un problema de adoptar este enfoque es que los enlaces se volverán inválidos si cambia el contenido del archivo al que está vinculando sin cambiar el enlace. Este es uno de los problemas de separar el código fuente y la documentación.

En lugar de vincular a una línea particular en otro archivo, ¿por qué no incluye la parte específica del archivo que le interesa en la documentación? Usted podría:

  • incluyen todo el archivo con \include (también hay \includelineno) y acaba de Referencia partes pertinentes de la misma en el texto (por ejemplo, "la función xxx en el código de abajo"), o
  • incluye fragmentos del archivo donde necesita referirse a ellos en la documentación usando \snippet.

Editar: Como alternativa, puede utilizar el comando \dontinclude que, junto con los \line, \skip, \skipline y \until comandos le permite incluir líneas/bloques de un archivo en particular específicos. Vea el ejemplo en la documentación \dontinclude.

+0

Gracias por sus sugerencias. El comando '\ snippet' parecía prometedor, sin embargo, solo funciona para los fragmentos de código de _source files_, mientras que yo quiero mostrar datos de mi _xml resource file_. No puedo agregar las etiquetas que identifican la ubicación del fragmento a mi archivo xml porque los comentarios estilo doxygen lo "romperían". El uso de \ include también es inteligente, pero es un archivo enorme y no quiero incluirlo cada vez (la documentación se borrará con datos irrelevantes). Sin embargo, cuando uso \ ref para mi archivo, ya hago referencia a partes relevantes, como sugiere. Solo estoy buscando una forma aún mejor. – wil

+1

@wil No hay problema. También agregué una nota sobre el comando '\ dontinclude', que sería mejor para usted que el comando' \ snippet' ya que no requiere que se agregue ninguna etiqueta a su archivo de recursos. Sin embargo, de acuerdo con la documentación, parece que este comando solo funciona en los archivos fuente (no lo he probado, así que no estoy seguro si este es realmente el caso). También podría incluir el XML directamente en su documentación. En su defecto, me temo que es posible que deba vivir usando su método '\ ref'. – Chris

+0

¡Probé los comandos '\ dontinclude' y también funciona para archivos xml! Me he conformado con esta solución y configuré su respuesta como "aceptada" :-) – wil

Cuestiones relacionadas