Discussão sobre a documentação MQL4 - página 8

 
Gorillych:
Tudo é compreensível, a documentação está lá, os exemplos estão lá, Rosh escreveu tudo.
A única coisa com a qual não estou satisfeito são os exemplos na documentação. Muitos desses exemplos já foram escritos aqui no site, e a documentação ainda é a mesma - idiota :(

Proponho (pela terceira vez, penso eu) acrescentar à documentação on-line no site a possibilidade de acrescentar seus próprios comentários. Isto é usado com sucesso em outras tecnologias de TI.
Aqui está um exemplo de tal descrição de função: básica, mais peças prontas de código abaixo de desenvolvedores terceirizados - pegar e copiar.

 
Yurixx, o que exatamente está errado com a documentação? Por favor, dê-nos uma indicação clara dos erros e nós iremos corrigi-los.

Por exemplo, houve um erro com um identificador não especificado e nós já o corrigimos:

Jhonny escreveu (a):
A propósito de documentação, notei algo estranho quando pressiono F1 na propriedade OBJPROP_FIBOLEVELS na documentação, algo dá errado ou quase nada acontece.


Mas se você quiser ter a documentação mais detalhada para todos os casos, infelizmente não podemos fazer isso. A inserção do analógico MSDN no terminal será difícil. Não importa o que escrevemos, ainda haverá perguntas. E mesmo ter artigos, uma biblioteca de códigos, um fórum e um mecanismo de busca para todas essas coisas nem sempre ajudará.


O tópico desta linha me fez formular claramente um pensamento há muito esperado. A abordagem teórica "me dê um bom documento/livro e eu mudarei o mundo" não é suficiente. É necessária a prática com o uso obrigatório e independente de ancinhos.

Estudo de caso de nossa prática:

Há muito tempo temos melhorado a metodologia de desenvolvimento de software e também estamos nos preparando para a certificação ISO9000. Nos últimos dois anos, adquirimos dezenas de livros sobre o assunto, relemos muito, todos eles concordam com a necessidade de implementação. Mas a teoria não é suficiente. Você tem que se familiarizar com isso e fazer isso. O que estamos fazendo passo a passo.

É difícil - depois de ler livros, sua cabeça está uma bagunça. É o momento certo para sair e gritar "a documentação não presta". Imediatamente o pensamento "vamos chamar os consultores" e deixá-los fazer tudo por nós aqui. Mas a razão nos diz que temos que entender e mudar as coisas nós mesmos, e não apenas ler o relatório aguado dos consultores.

É a mesma coisa nos negócios. Se você lê apenas livros, tudo parece simples - "acredite em si mesmo, abalou, abriu um negócio e tudo continuou". A vida é diferente.

Nossa posição sobre a documentação:

  • para se engajar no treinamento interativo de comerciantes em todo o mundo através de um site especial MQL4.community
  • proporcionar aos comerciantes a possibilidade de se ajudarem mutuamente e compartilharem conhecimentos
  • Permitir que os comerciantes se comuniquem diretamente com os desenvolvedores.
  • estimular a escrita de artigos por comerciantes, traduzi-los para outros idiomas
  • Para coletar informações em um só lugar para que qualquer pessoa possa acessá-las

Ou seja, nossa tarefa educacional é muito mais ampla do que a mais simples documentação integrada. Por exemplo, ontem eu voei de Xangai, onde abri nosso escritório para promover o MetaTrader na China. Haverá grandes mudanças na parte chinesa de nossos sites nos próximos meses.

Veja de forma mais ampla como estamos fazendo isso.

 
chv:

Proponho (pela terceira vez, penso eu) que a documentação on-line no site deve permitir que você acrescente seus próprios comentários. Isto tem sido utilizado com sucesso em outras tecnologias de TI.
Aqui está um exemplo de tal descrição de função: básica, mais peças de código prontas de desenvolvedores terceirizados - pegue e copie.

Sim, é uma boa idéia e muito provavelmente vamos implementá-la.

Continuamos trabalhando no site da MQL4 e temos muitas idéias. Amanhã lançaremos a versão beta do novo editor para o site. Depois haverá uma nova versão da função avançada "Tópicos Relacionados".
 
Quero dizer mais uma coisa, este tópico freqüentemente envia novatos aos artigos da Rosha, mas também o visito com freqüência, mas não o faço há algum tempo, porque o site da Alpari mudou um pouco e todos os links daqui "Artigos da Rosh: especialistas em MetaTrader 4" levam ao erro 404. Portanto, tenho que corrigir os links.

Claro que vi os comentários mais tarde, mas o artigo que eu queria estava quase no topo, e é por isso que não percebi imediatamente.
 
Jhonny:
Quero dizer mais uma coisa, este tópico freqüentemente envia novatos aos artigos da Rosha, mas também o visito com freqüência, mas não o faço há algum tempo, porque o site da Alpari mudou um pouco e todos os links daqui "Artigos da Rosh: especialistas em MetaTrader 4" levam ao erro 404. Portanto, eu tenho que corrigir estes links.
Estamos esperando que a Alpari corrija os links - eles prometeram.
 
Renat:
Yurixx, o que exatamente está errado com a documentação? Por favor, dê-nos uma indicação clara dos erros e nós iremos corrigi-los.

Se você quiser ter a documentação mais detalhada para todas as ocasiões, infelizmente, isto não vai funcionar. Será difícil inserir o analógico MSDN no terminal. Não importa o que escrevemos, ainda haverá perguntas. E mesmo ter artigos, uma biblioteca de códigos, um fórum e um mecanismo de busca para todas essas coisas nem sempre ajudará.

O tópico deste tópico me fez formular claramente um pensamento há muito esperado. A abordagem teórica "me dê um bom documento/livro e eu mudarei o mundo" não é suficiente. Exige a prática de pisar no ancinho de forma obrigatória e independente.

Nossa posição sobre a documentação:

  • engajar-se na educação interativa de comerciantes em todo o mundo através do site dedicado MQL4.community
  • oferece aos comerciantes a oportunidade de ajudar uns aos outros e compartilhar conhecimentos
  • , dando aos comerciantes a oportunidade de se comunicar diretamente com os desenvolvedores
  • incentivar os comerciantes a escrever artigos e traduzi-los para outros idiomas
  • acumular informações em um único local para que qualquer pessoa possa acessá-las
Não quero ter a documentação mais detalhada para todas as ocasiões, etc. É apenas uma questão de documentação normal. Alguns desejos expressos neste tópico, eu combinei em meu post na página 3. A parte de documentação foi a seguinte:

Deve haver um capítulo descrevendo (como alex_ant escreveu) o mecanismo de operação de um programa de MQL. Isto é algo que todo comerciante que é novo em programação pode entender mesmo antes de aprender a linguagem. E esta descrição deve estar ligada ao processo de negociação, e também pode explicar a diferença entre indicadores, scripts e Expert Advisors, como eles se comportam em relação à fila de carrapatos, ao servidor de negociação, uns aos outros, etc.

Deve ser dada mais atenção à estrutura do programa MQL, seus principais componentes - as funções init(), start() e deinit(). Estas funções são a principal diferença entre a MQL e outros idiomas, e a documentação lhes dá muito pouco espaço, quase apenas algumas linhas.

Seria muito bom examinar todas as entradas do dicionário e não apenas eliminar erros e erros de digitação, mas também levar a terminologia a um denominador comum. Muitas vezes as descrições dos mesmos parâmetros de funções e procedimentos ou de parâmetros semelhantes são feitas usando termos bem diferentes e seu significado não é explicado. Como resultado, as descrições estão disponíveis, mas o significado e o uso de alguns parâmetros têm que ser estudados em uma experiência.


É muito importante (concordo totalmente com 4x4ever ) trazer exemplos em linha reta! A grande maioria dos exemplos nos artigos do dicionário não explica nada e não ensina nada. Na verdade, um exemplo de uma linha não é um exemplo! Em um manual normal, o exemplo permite compreender tanto o significado dos parâmetros, como a ordem na qual o procedimento/função é utilizado e o resultado que produz. E para isso, não é necessário escrever seu próprio programa. IMHO: a fraqueza dos exemplos do Dicionário MQL é um dos principais inconvenientes da documentação.

Você tem que admitir que não é muito.

Renat, a postura de sua firma em relação à documentação merece todo o respeito devido. Entretanto, observe que não há um único item nos pontos que você listou que esteja diretamente relacionado à documentação. Todos eles são bons, mas a base é o material, com o qual todos aprendem e programas em MQL. Atualmente, estes são o Dicionário (ou seja, documentação) e, em segundo lugar, publicações em websites. Para fazer o trabalho adicional, você precisa construir uma base forte. Ou seja, trazer a Referência MQL para a qualidade desejada.
 

Renat escreveu (a):
Yurixx, o que exatamente está errado na documentação? Por favor, dê-nos uma indicação clara dos erros e nós iremos corrigi-los.


Yurixx:
Renat, a posição de sua firma sobre a documentação merece todo o respeito devido. Entretanto, observe que não há um único nos pontos que você listou que esteja diretamente relacionado à documentação. Todos eles são bons, mas a base é o material, com o qual todos aprendem e programas em MQL. Atualmente, estes são o Dicionário (ou seja, documentação) e, em segundo lugar, publicações em websites. Para fazer o trabalho adicional, você precisa fazer uma base sólida. Ou seja, trazer a Referência MQL para a qualidade desejada.

Portanto, entendo que não há indicação clara de erros óbvios. É uma pena.
 
Renat:

Presumo que não há indicação clara de erros óbvios. É uma pena.

Normalmente nesses casos, para não se esforçarem:) para procurar erros específicos, eles dão um monte de referências de várias páginas a GOSTs, SNiPs e ISOs, com uma oferta para trazer o produto de acordo com a lista especificada. É uma pena não me lembrar dos números e não tenho vontade de procurá-los, caso contrário, eu jogaria a lista em você ;)
É uma piada.

Renat, que novo editor do site você mencionou anteriormente quando planejava lançá-lo?
 
chv:

Renat, que novo editor para o site você mencionou anteriormente aqui, planejando lançar?
Fizemos uma nova versão, mais fácil de usar do editor on-line para a seção de fóruns e artigos. Esta versão torna muito mais fácil a criação de postos.

Uma das novas características (ainda não incluídas) será a inserção de videoclipes. Tanto seus próprios clipes quanto os clipes do YouTube. Muito provavelmente, lançaremos o beta de teste público na segunda-feira.
 
Renat:

Renat escreveu (a):
Yurixx, o que exatamente está errado na documentação? Por favor, forneça indicações claras de erros e nós iremos corrigi-los.

Entendo que não há uma indicação clara dos erros óbvios. É uma pena.


Você, Renat, está tirando conclusões precipitadas. Parece que você realmente quer se livrar dos irritantes "críticos" sem muito esforço. Depois de tão belamente proclamada posição da empresa, sugere que, de fato, por trás destas proclamações está uma relutância em ouvir os desejos dos usuários. De fato, a própria MQ sabe o que fazer e como fazê-lo, o que os usuários têm a ver com isso.

Posso assegurar-lhes que vocês entenderam mal a situação. Posso muito bem lhe dar indicações claras do que precisa ser melhorado. Mas antes, deixe-me deixar algo claro. Esta frase, tão convincentemente marcada em vermelho, sugere claramente o seguinte: se você apontar erros, nós os consertaremos, mas não vamos olhar a documentação por nós mesmos. E a frase "erros óbvios" também é sugestiva. Durante 2 anos de depuração e graças à ajuda dos membros deste fórum, o número de "erros óbvios" foi reduzido ao mínimo e continua a diminuir. Mas ainda assim você deixa claro com esta frase que não está interessado em informações sobre outros erros que não são "óbvios". E você não está muito interessado em maus exemplos, explicações incompreensivelmente escritas e similares.

Além disso, você realmente quer que eu dê instruções sobre TODOS os erros de documentação? Não Renat, desculpe. Sua empresa pode não escrever um manual sobre MQL - tudo bem. Mas ela deve revisar a documentação sobre o idioma. Sim, deve! Quem mais, senão o criador da língua, deve documentá-la? De que outra forma, mas com base nesta documentação, os programadores podem aprender a usar esta linguagem?

Portanto, para não ser infundado, vou lhe dar um exemplo típico. Se você não estiver interessado na qualidade da documentação, certamente descobrirá porque o que escrevi é lixo. Se houver algum elemento construtivo nesta conversa, sem dúvida você entenderá o que quero dizer. Mas você já sabe o que quero dizer.

No entanto, aqui está um exemplo.

int ArrayRange( matriz de objetos[], int range_index)
Retorna o número de elementos na dimensão dada da matriz. Como os índices começam em zero, o tamanho da dimensão é 1 a mais do que o maior índice.

Parâmetros:

matriz[] - Matriz verificada
range_index - Índice de dimensão.

Exemplo:
int dim_size; double num_array[10,10,10]; dim_size=ArrayRange(num_array, 1);
.


Normalmente, um índice é uma variável que numera os elementos de uma matriz. Neste caso, não é um índice, mas um número índice. No entanto, a partir da frase "Como os índices começam com zero, o tamanho da dimensão é 1 a mais do que o maior índice". "nem isto nem nada mais pode ser compreendido. Especialmente para um iniciante.

O que você quer dizer com "desde..." ? Onde isso foi estipulado antes? Em nenhum lugar! Porque esta é uma função específica e a variávelrange_index, que numera as medidas, não aparece em nenhum outro lugar. Portanto, basta dizer que a numeração das medidas começa a partir de 0. E o número da medida (não o tamanho !) é 1 a mais do que o maior valor da variávelrange_index (não "índice"). Melhor ainda, não aperte tudo em uma frase, mas explique tudo em 2-3 frases de forma consistente e inteligível.

O exemplo dado na descrição é um clássico do Handbook. O que ele pode esclarecer? Nada ! Se você, Renat, não sabe como deve ser, veja a foto no primeiro post desta página. Pelo menos deve haver uma impressão dos resultados das operações dadas no exemplo. E que valor a variáveldim_size tomou como resultado? Eu sei que você sabe, mas será que os iniciantes da língua sabem disso?

E mesmo que estivesse escrito com o tamanho dim_size=10, será que isso ajudaria alguém a entender alguma coisa? O autor deste exemplo, talvez apenas por razões humorísticas, colocou o número 10 em todas as três dimensões da matriz.

Aqui está um exemplo de uma atitude em relação à escrita de documentação. Pense você mesmo em um epíteto para a palavra "atitude".
Quantos erros "óbvios" você contou aqui? Nem um único, eu acho.
Mas posso assegurar-lhes - há muitos mais artigos deste tipo no Manual que não contêm erros óbvios, mas reduzem muito a qualidade da documentação nele contida.
Razão: