Documenting a project

In application projects, you can document your methods as well as your forms, tables, or fields. Creating documentation is particularly appropriate for projects being developed by multiple programmers and is generally good programming practice. Documentation can contain a description of an element as well as any information necessary to understand how the element functions in the application.

Os seguintes elementos do projeto aceitam documentação:

• Methods (database methods, component methods, project methods, form methods, 4D Mobile methods, triggers, and classes)
• Classes
• Formulários
• Tabela

Your documentation files are written in Markdown syntax (.md files) using any editor that supports Markdown. São armazenados como ficheiros independentes na pasta do seu projeto.

Documentation is displayed in the preview area (right-side panel) of the Explorer:

It can also be partially exposed as code editor tips.

Ficheiros documentação

Nome do ficheiro de documentação

Documentation files have the same name as their attached element, with the ".md" extension. For example, the documentation file attached to the myMethod.4dm project method will be named myMethod.md.

In the Explorer, 4D automatically displays the documentation file with the same name as the selected element (see below).

Arquitetura dos ficheiros de documentação

All documentation files are stored in the Documentation folder, located at the first level of the package folder.

A arquitetura da pasta Documentation é a seguinte:

• Documentation

  • Classes
    • myClass.md
  • DatabaseMethods
    • onStartup.md
    • ...
  • Formulários
    • loginDial.md
    • ...
  • Página Métodos
    • myMethod.md
    • ...
  • TableForms
    • 1
      • input.md
      • ...
    • ...
  • Triggers
    • table1.md
    • ...

• A project form and its project form method share the same documentation file for form and method.

• A table form and its table form method share the same documentation file for form and method.

Renaming or deleting a documented element in your project will also rename or delete the element's associated Markdown file.

Documentação no Explorador

Ver a documentação

Para visualizar a documentação na janela do Explorer:

1. Certifique-se de que a área de pré-visualização é mostrada.
2. Selecione o elemento documentado na lista do Explorador.
3. Click the Documentation button located below the preview area.

• If no documentation file was found for the selected element, a Create button is displayed (see below).

• Otherwise, if a documentation file exists for the selected element, the contents are displayed in the area. Os conteúdos não são diretamente editáveis no painel.

Editar o ficheiro de documentação

You can create and/or edit a Markdown documentation file from the Explorer window for the selected element.

Se não houver um arquivo de documentação para o elemento selecionado, você poderá:

• click on the Create button in the Documentation pane or,
• choose the Edit Documentation... option in the contextual menu or options menu of the Explorer.

4D automatically creates an appropriately named .md file with a basic template at the relevant location and opens it with your default Markdown editor.

If a documentation file already exists for the selected element, you can open it with your Markdown editor by choosing the Edit Documentation... option in the contextual menu or options menu of the Explorer.

Ver a documentação no editor de código

The 4D code editor displays a part of a method's documentation in its help tip.

Se existir um ficheiro com o nome \<MethodName>.md na pasta \<package>/documentation, o editor de código é apresentado (por prioridade):

• Any text entered in an HTML comment tag (<!-- command documentation -->) at the top of the markdown file.

• Or, if no html comment tag is used, the first sentence after a # Description tag of the markdown file.
  In this case, the first line contains the prototype of the method, automatically generated by the 4D code parser.

nota

Caso contrário, o editor de código exibe o comentário do bloco na parte superior do código do método.

Definição do ficheiro de documentação

4D usa um modelo básico para criar ficheiros de documentação. This template suggests specific features that allow you to display information in the code editor.

However, you can use any supported Markdown tags.

New documentation files are created with the following default contents:

Linha	Descrição
<!-- Escreva aqui o seu resumo -->	Comentário HTML. Used in priority as the method description in the code editor tips
## Description	Título de nível 2 em Markdown. The first sentence after this tag is used as the method description in the code editor tips if HTML comment is not used
## Exemplo	No nível 2 do cabeçalho, você pode usar essa área para mostrar um código de amostra
```4d Type here your example```	Utilizado para formatar exemplos de código 4D (utiliza a biblioteca highlight.js)

Markdown suportado

• A etiqueta de título é suportada:

# Title 1
## Title 2
### Title 3

• As etiquetas de estilo (itálico, negrito, riscado) são suportadas:

_italic_
**bold**
**_bold/italic_**
~~strikethrough~~

• A etiqueta de bloco de código (```4d ... ```) é suportada com realce do código 4D:

```4d
    var $txt : Text
    $txt:="Hello world!"  
```

• A etiqueta de tabela é suportada:

| Parâmetro | Tipo | Descrição |
| --------- | ------ | ------------ |
| wpArea | String |Área de escrita profissional|
| toolbar | String |Nome da barra de ferramentas |

• A etiqueta de ligação é suportada:

// Case 1 The [documentation](https://doc.4d.com) of the command ....

// Case 2
[4D blog][1]

[1]: https://blog.4d.com

• As etiquetas de imagem são suportadas:

![image info](pictures/image.png)

![logo 4D](https://blog.4d.com/wp-content/uploads/2016/09/logoOrignal-1.png "4D blog logo")

[![logo 4D blog with link](https://blog.4d.com/wp-content/uploads/2016/09/logoOrignal-1.png "4D blog logo")](https://blog.4d.com)

Para obter mais informações, consulte o guia GitHub Markdown.

Exemplo

No ficheiro WP SwitchToolbar.md, pode escrever:

<!-- This method returns a different logo depending on the size parameter -->


<!-- This method returns a different logo depending on the size parameter --> GetLogo (size) -> logo


| Parameter | Type   | in/out | Description |
| --------- | ------ | ------ | ----------- |
| size      | Longint | in | Logo style selector (1 to 5)  |
| logo      | Picture | out | Selected logo |


## Description This method returns a logo of a specific size, depending on the value of the *size* parameter value.
1 = tamanho mais pequeno, 5 = tamanho maior.

## Example C_PICTURE($logo)
C_LONGINT($size)

//Get the largest logo
$logo:=GetLogo(5)

• Explorer view:

• Code editor view: