monodocer - Online en la nube

PROGRAMA:

NOMBRE

monodocer - Soporte de formato de documentación ECMA

SINOPSIS

monodocer [OPCIONES] *

OPCIONES

-montaje: MONTAJE
ASAMBLEA es un ensamblado .NET para generar códigos auxiliares de documentación.

Especifique una ruta de archivo o el nombre de un ensamblado GAC.

-borrar
Permitir que monodocer elimine miembros de los archivos de documentación. Los únicos miembros
suprimidos son para miembros que ya no están presentes en la asamblea.

Si un tipo ya no está presente, el archivo de documentación se no eliminado, pero es
rebautizado tener un .retirar extensión.

- ?, -ayuda
Muestra información sobre los argumentos del programa.

-no recuerda a los miembros
No actualice a los miembros.

Esto agregará resguardos de documentación para tipos agregados, pero no añadir o quitar
documentación para miembros de cualquier tipo (incluidos los tipos añadidos).

-importslashdoc: ARCHIVO
ARCHIVO es un archivo XML generado con el / doc: ARCHIVO Indicador del compilador de C # (p. Ej. mcs
-doc: foo.xml foo.cs ). Importar la documentación de miembro contenida en ARCHIVO into
el formato de documentación utilizado por monodoc.

-nombre nombre
NOMBRE es el nombre del proyecto para el que es esta documentación.

Esto establece el / Descripción general / Título elemento dentro del índice.xml archivo creado en el
directorio especificado por -camino . Algunos programas lo utilizan para obtener información sobre el título.
(p.ej monodocs2html ).

-espacio de nombres: NAMESPACE
Actualice solo los tipos dentro del espacio de nombres ESPACIO DE NOMBRES .

anulaciones
Incluya métodos anulados en la documentación.

Normalmente, esto no es necesario, ya que Mono Documentation Browser proporcionará una
enlazar a los miembros de tipo base de todos modos, al igual que monodocs2html si el tipo base es
dentro del mismo montaje.

-ruta: OUTPUT_DIR
SALIDA_DIR es el directorio que contendrá los talones de documentación nuevos / actualizados.

-bonita
Sangra bien los archivos XML.

-desde: DESDE
Crear un elemento para tipos y miembros agregados con el valor YA QUE .

Por ejemplo, cuando se le da -desde: "Gtk # 2.4" un elemento se insertará en el Docs
elemento para todos los tipos y miembros de tipo agregados:

El navegador de documentación Mono y monodocs2html usará este elemento para especificar
en qué versión se agregó un miembro.

-tipo: TIPO
Solo cree / actualice la documentación para el tipo TIPO .

-actualizar a: RUTA
Al actualizar la documentación, escriba los archivos de documentación actualizados en el
directorio TRAYECTORIA .

-V, -versión
Muestra información sobre la versión y la licencia.

DESCRIPCIÓN

monodocer ha sido obsoleto por mdoc(1). Ver el actualización de mdoc(1) página de manual.

monodocer es un programa que crea stubs de documentación XML en la documentación de ECMA
Formato. No se basa en la documentación que se encuentra en el código fuente.

Las ventajas son:

* Código legibilidad. La buena documentación suele ser (a) detallada y (b) completa
con ejemplos. (Para comparar, compare la documentación de Microsoft .NET Framework,
que suele ser una página o más de documentos para cada miembro, a la documentación de JavaDoc,
que a menudo puede ser una oración para cada miembro).

Insertar buena documentación en el código fuente con frecuencia puede sobrecargar la fuente.
archivo, ya que la documentación puede ser más larga que el método real que se está
Documentada.

* Localización Formatos de documentación en origen (como / Doc ) no tienen soporte para
múltiples lenguajes humanos. Si necesita admitir más de un lenguaje humano para
fines de documentación, monodocer es útil ya que permite que cada idioma obtenga su
propio directorio, y monodocer puede agregar tipos / miembros para cada documentación separada
directorio.

* Administración. No es inusual tener documentación y desarrollo separados
equipos. También es posible que el equipo de documentación tenga una experiencia mínima
con el lenguaje de programación que se está utilizando. En tales circunstancias, en línea
La documentación no es deseable ya que el equipo de documentación podría insertar inadvertidamente
un error en el código fuente al actualizar la documentación. Alternativamente, usted
puede que no desee que el equipo de documentación tenga acceso al código fuente por motivos de seguridad
razones. monodocer permite conservar la documentación completamente separado y
distinto del código fuente utilizado para crear el ensamblado.

Para encender el monodocer documentación en algo que pueda ser consumido por Mono
Navegador de documentación (el navegador de ayuda del escritorio o la interfaz web) es
necesario para compilar la documentación en un formato empaquetado. Esto se hace con el
mdassembler, por ejemplo, podría usar esta cadena de herramientas como esta:

$ monodocer -assembly: MyWidgets -path: generate_docs
$ mdassembler --ecma generate_docs -out: MyWidgets

Lo anterior generaría un MyWidgets.zip y un MyWidgets.tree que luego se pueden instalar
en el sistema. Además de los dos archivos (.zip y .tree), debe proporcionar un .sources
archivo que describe en qué parte del sistema de ayuda se debe conectar la documentación, es
un archivo XML muy simple, como este:






El archivo de configuración anterior describe que la documentación está en formato ECMA (el
versión compilada) que el nombre del archivo base es MyWidgets y que debe estar conectado
la parte "classlib-gnome" del árbol. Si desea ver los distintos nodos definidos
en la documentación, puede ver el archivo monodoc.xml que normalmente se instala en
/usr/lib/monodoc/monodoc.xml.

Una vez que tenga todos sus archivos (.zip, .tree y .sources), puede instalarlos en el
sistema con el siguiente comando:

$ cp MyWidgets.tree MyWidgets.zip MyWidgets.source `pkg-config monodoc --variable sourcedir`

Lo anterior copiará los archivos en el directorio que Monodoc ha registrado (puede
necesita permisos de root para hacer esto). El directorio real es devuelto por el paquete-config
invocación.

CADENA ID FORMATO

Los ID de cadena se utilizan para hacer referencia a un tipo o miembro de un tipo. Los ID de cadena están documentados en
ECMA-334 3ª edición, anexo E.3.1. Consisten en un miembro tipo prefijo , el tipo completo
nombre (espacio de nombres + nombre, separados por '.'), posiblemente seguido del nombre del miembro y otros


Prefijos de tipo de miembro:

E: El ID de cadena se refiere a un evento. El nombre del evento sigue al nombre del tipo:
E: System.AppDomain.AssemblyLoad

F: El ID de cadena se refiere a un campo. El nombre del campo sigue al nombre del tipo:
F: System.Runtime.InteropServices.DllImportAttribute.SetLastError

M: Se refiere a un constructor o método. Anexar constructores .ctor al nombre del tipo,
mientras que los métodos agregan el nombre del método (con un recuento opcional del número de
parámetros genéricos).

Si el constructor o el método toman argumentos, estos se enumeran entre paréntesis.
después del nombre del constructor / método:

M: System.Object..ctor , M: System.String..ctor (System.Char []) ,
M: System.String.Concat (System.Object) , M: System.Array.Sort "1 (" 0 []) ,
M: System.Collections.Generic.List`1..ctor ,
M: System.Collections.Generic.List`1.Add (`0) .

N: Se refiere a un espacio de nombres, p. Ej. N: sistema

P: Se refiere a una propiedad. Si la propiedad es un indexador o toma parámetros, el
los tipos de parámetros se añaden al nombre de la propiedad y se encierran entre paréntesis:
P: System.String.Length , P: System.String.Chars (System.Int32) .

T: El ID de cadena se refiere a un tipo, con el número de tipos genéricos adjuntos:
T: System.String , T: System.Collections.Generic.List`1

Para hacer las cosas más interesantes, los tipos y miembros genéricos tienen dos representaciones:
representación "independiente" (que se muestra en los ejemplos anteriores), en la que los nombres de clase tienen el recuento de
parámetros genéricos añadidos a su nombre. También hay una representación "ligada", en
cuyo enlace de parámetros genéricos se enumera dentro de '{' y '}'.

Sin consolidar: T: System.Collections.Generic.List`1 , T: System.Collections.Generic.Dictionary`2 .

Ligado: T: System.Collections.Generic.List {System.Int32}
T: System.Collections.Generic.Dictionary {System.String, System.Collections.Generic.List {System.Predicate {System.String}}}
.

Como puede ver, las variantes enlazadas pueden ser arbitrariamente complejas (como los genéricos).

Además, si un parámetro genérico está vinculado al parámetro genérico de un tipo o método,
el "índice" del parámetro genérico del tipo / método se utiliza como enlace, por lo que
clase Tipo de pie {
público estático vacío foo (Sistema.Predicado predicado) {}
}
El ID de cadena para este método es M: FooType.Foo''1 (System.Predicate {`` 0}) , ya que `` 0 son los
0o índice de parámetro genérico que está vinculado a System.Predicate .

DOCUMENTACIÓN FORMATO

monodocer genera documentación similar al formato de documentación de Ecma, como se describe
en ECMA-335 3rd Edition, Partition IV, Chapter 7.

La principal diferencia con el formato ECMA es que cada tipo obtiene su propio archivo, dentro de
un directorio idéntico al espacio de nombres del tipo.

La mayor parte de la información contenida en la documentación debe no ser editado. Esto incluye el
escribe un nombre ( / Escriba / @ FullName ), interfaces implementadas ( / Tipo / Interfaces ), miembro
información ( / Tipo / Miembros / Miembro / @ MemberName , / Tipo / Miembros / Miembro / Miembro Firma ,
/ Tipo / Miembros / Miembro / Tipo de miembro , / Tipo / Miembros / Miembro / Parámetros , Etc).

What should ser modificados son todos los elementos con el texto A be añadido. , que están presentes
bajo el // Documentos elementos (p. ej. / Tipo / Documentos , / Tipo / Miembros / Miembro / Documentos ). Los contenidos
de las Docs elemento es idéntico en semántica y estructura a la documentación en línea de C #
formato, que consta de estos elementos (enumerados en ECMA-334 3ª edición, anexo E, sección 2).
Los siguientes se utilizan dentro de las descripciones de los elementos:

CREF Se refiere a una referencia de clase (o miembro) y es una cadena en el formato descrito
arriba en el CADENA ID FORMATO .

TEXTO El texto que no sea XML y XML no deben estar anidados.

XML Solo los elementos XML deben estar anidados (que indirectamente pueden contener texto), pero no
El texto de espacio en blanco no debe ser un nodo secundario inmediato.

TEXTO_XML
XML y texto de formato libre, de modo que se puedan anidar otros elementos XML.

Los siguientes elementos se utilizan en la documentación:

<bloque subconjunto = "SUBSET" type = "TYPE"> XML_TEXT
Crea un bloque de texto, similar en concepto a un párrafo, pero se usa para crear
divisiones dentro del texto. Hasta cierto punto, un es equivalente al HTML
etiqueta.

SUBCONJUNTO siempre debe ser el valor ninguna .

TIPO especifica el encabezado y el formato que se utilizará. Los tipos reconocidos son:

comportamientos Crea una sección con el encabezado Operación .

nota Crea una sección con el encabezado Nota: .

anula Crea una sección con el encabezado Nota a Herederos .

personal Crea una sección con el encabezado Uso .

XML_TEXT
Establezca el texto en una fuente similar a un código (similar al elemento HTML ).

<código lang = "IDIOMA"> TEXTO
Muestre varias líneas de texto en una fuente similar a un código (similar al HTML
elemento). IDIOMA es el idioma para el que es este bloque de código. Por ejemplo, si
IDIOMA is C# , entonces TEXTO obtendrá resaltado de sintaxis para el lenguaje C # dentro de
el navegador de documentación Mono.

XML_TEXT
Indica un ejemplo que debe mostrarse especialmente. Por ejemplo:

Un párrafo introductorio.

clase Ejemplo {
vacío estático público Main ()
{
System.Console.WriteLine ("¡Hola, mundo!");
}
}



<excepción cref = "CREF"> XML_TEXT
Identifica una excepción que puede lanzar el miembro documentado.

es un elemento de nivel superior y debe estar anidado directamente debajo de la
.

CREF es el tipo de excepción que se lanza, mientras que TEXTO_XML contiene el
circunstancias que causarían CREF para ser arrojado.

era .


XML
Crea una lista o tabla de elementos. hace uso de anidado XML ,
XML , XML_TEXT y
XML_TEXT elementos.

Listas tener la sintaxis:

Bala 1
Bala 2
Bala 3


Mesas tener la sintaxis:


Columna 1
Columna 2
Columna 3


Elemento 1-A
Elemento 1-B
Elemento 1-C


Elemento 2-A
Elemento 2-B
Elemento 2-C



XML_TEXT
Insertar un párrafo de TEXTO_XML
. Esto es para usar con otras etiquetas, como , ,
, y (consulta: , arriba) y la mayoría de los demás elementos.

Por ejemplo,
Este es un párrafo de texto.

<parámetro name = "NAME"> XML_TEXT
es un elemento de nivel superior y debe estar anidado directamente debajo de la
.

Describe el parámetro NOMBRE del constructor, método o propiedad actual:

A que contiene el número
de widgets para procesar.


<paramref nombre = "NOMBRE" />
Indica que NOMBRE Es un parámetro.

Esto generalmente se traduce NOMBRE como texto en cursiva, por lo que se utiliza con frecuencia (ab) como un
equivalente al elemento HTML . Ver el documentación (arriba)
para un ejemplo.

<permiso cref = "CREF"> XML_TEXT
Documenta los requisitos de seguridad de accesibilidad del miembro actual.

es un elemento de nivel superior y debe estar anidado directamente debajo de la
.

CREF es una referencia de tipo al permiso de seguridad requerido, mientras que TEXTO_XML es un
descripción de por qué se requiere el permiso.

Requiere permiso para leer y escribir archivos. Ver
,
.


XML_TEXT
Contiene información detallada sobre un miembro.

es un elemento de nivel superior y debe estar anidado directamente debajo de la
.
Inserte información detallada aquí.

XML_TEXT

es un elemento de nivel superior y debe estar anidado directamente debajo de la
.

Describe el valor de retorno de un método:

A especificando si
o no el proceso puede acceder
.


<ver cref = "CREF" />
Crea un enlace al miembro especificado dentro del texto actual:


<ver también cref = "CREF" />

es un elemento de nivel superior y debe estar anidado directamente debajo de la
.

Permite generar una entrada para el See También subcláusula. Usar para especificar
un enlace desde dentro del texto.


<desde version = "VERSION" />

es un elemento de nivel superior y debe estar anidado directamente debajo de la
.

Permite especificar qué versión introdujo el tipo o miembro especificado.


DESCRIPCIÓN

es un elemento de nivel superior y debe estar anidado directamente debajo de la
.

Proporciona una descripción general (breve) sobre un tipo o miembro de tipo.

Esto generalmente se muestra como parte de una declaración de clase y debe ser una
descripción razonablemente breve del tipo / miembro. Usar para más detalles


<tipoparam name = "NAME"> DESCRPITION
es un elemento de nivel superior y debe estar anidado directamente debajo de la
.

Se utiliza para describir el parámetro de tipo para un tipo genérico o un método genérico.

NOMBRE es el nombre del parámetro de tipo, mientras que DESCRIPCIÓN contiene una descripción de
el parámetro (para qué se usa, qué restricciones debe cumplir, etc.).
El tipo de colección subyacente


Se usa para indicar que una palabra es un parámetro de tipo, para usar dentro de otros bloques de texto.
(por ejemplo, dentro de ).
Si es una estructura, entonces ...

DESCRIPCIÓN
es un elemento de nivel superior y debe estar anidado directamente debajo de la
.

Permite describir una propiedad.

A que contiene un nombre de widget.

Utilice monodocer en línea utilizando los servicios de onworks.net