MSTECH wiki - Contribuições do usuário [pt-br]

Instalacao SonarQube

2016-08-25T17:08:52Z

Gabriel.scavassa: Limpou toda a página

Grupo de Qualidade (GQA)

2016-08-25T17:08:06Z

Gabriel.scavassa: /* Documentação das Integrações */

==Objetivos==

* Promover a criação dos pilares do Desenvolvimento Ágil
* Criar, divulgar e zelar pelo respeito às diretrizes de Desenvolvimento de Software nas áreas de:
** Segurança da Informação
** Padronização
** Desempenho/Escalabilidade
* Identificar os possíveis gargalos e problemas nos processos de produção, propor e implementar ações corretivas
* Fomentar em toda a empresa a busca pela melhoria contínua da qualidade do software produzido pela MStech

==Documentação das Integrações==
* [[Gitlab + Youtrack]]
* [[Instala%C3%A7%C3%A3o SonarQube]]
* [[Jenkins + SonarQube]]

==Backlog==
{| class="wikitable"
| align="center" style="background:#f0f0f0;"|'''ID'''
| align="center" style="background:#f0f0f0;"|'''Necessidade'''
| align="center" style="background:#f0f0f0;"|'''Atividade'''
| align="center" style="background:#f0f0f0;"|'''Responsável'''
|-
| 01 || Finalizar Build Automático no GIT/Jenkins||Acrescentar o compare de banco de dados||Daniel Alves
|-
| 02 || Finalizar Build Automático no GIT/Jenkins||Acrescentar o uso do npm além do NuGET (já implementado)||Daniel Alves
|-
| 03 || Code Review||Definir controles para serem usados no code review. Inicialmente alguns controles, mas que provocarão diferenças no resultado final (por exemplo, verificar o )||Gabriel Scavassa / Daniel Alves
|-
| 04 || Migração de projetos para GIT||Construir agenda de migração para os sistemas da SME-SP||Débora Santos
|-
| 05 || Ferramenta de workflow||Pesquisar ferramenta de workflow free||Todos
|-
| 06 || Clarificar as ferramentas de desenvolvimento||Listar ferramentas e responsabilidade de cada uma delas||Ricardo Agulhari
|-
| 07 || Ambientes não padronizados||Acertar ambientes de teste e homologação||
|-
|}

==Participantes==

* [mailto:daniel.alves@mstech.com.br Daniel Alves]
* [mailto:debora.santo@mstech.com.br Débora Santos]
* [mailto:gabriel.scavassa@mstech.com.br Gabriel Scavassa]
* [mailto:juan.falguera@mstech.com.br Juan Falguera]
* [mailto:lucimara.maiorali@mstech.com.br Lucimara Maiorali]
* [mailto:ricardo.agulhari@mstech.com.br Ricardo Agulhari]
* [mailto:rodrigo.edamatsu@mstech.com.br Rodrigo Edmatsu]

Grupo de Qualidade (GQA)

2016-08-25T17:07:50Z

Gabriel.scavassa: /* Documentação das Integrações */

==Objetivos==

* Promover a criação dos pilares do Desenvolvimento Ágil
* Criar, divulgar e zelar pelo respeito às diretrizes de Desenvolvimento de Software nas áreas de:
** Segurança da Informação
** Padronização
** Desempenho/Escalabilidade
* Identificar os possíveis gargalos e problemas nos processos de produção, propor e implementar ações corretivas
* Fomentar em toda a empresa a busca pela melhoria contínua da qualidade do software produzido pela MStech

==Documentação das Integrações==
* [[Gitlab + Youtrack]]
* [[Jenkins + SonarQube]]
* [[Instala%C3%A7%C3%A3o SonarQube]]

==Backlog==
{| class="wikitable"
| align="center" style="background:#f0f0f0;"|'''ID'''
| align="center" style="background:#f0f0f0;"|'''Necessidade'''
| align="center" style="background:#f0f0f0;"|'''Atividade'''
| align="center" style="background:#f0f0f0;"|'''Responsável'''
|-
| 01 || Finalizar Build Automático no GIT/Jenkins||Acrescentar o compare de banco de dados||Daniel Alves
|-
| 02 || Finalizar Build Automático no GIT/Jenkins||Acrescentar o uso do npm além do NuGET (já implementado)||Daniel Alves
|-
| 03 || Code Review||Definir controles para serem usados no code review. Inicialmente alguns controles, mas que provocarão diferenças no resultado final (por exemplo, verificar o )||Gabriel Scavassa / Daniel Alves
|-
| 04 || Migração de projetos para GIT||Construir agenda de migração para os sistemas da SME-SP||Débora Santos
|-
| 05 || Ferramenta de workflow||Pesquisar ferramenta de workflow free||Todos
|-
| 06 || Clarificar as ferramentas de desenvolvimento||Listar ferramentas e responsabilidade de cada uma delas||Ricardo Agulhari
|-
| 07 || Ambientes não padronizados||Acertar ambientes de teste e homologação||
|-
|}

==Participantes==

* [mailto:daniel.alves@mstech.com.br Daniel Alves]
* [mailto:debora.santo@mstech.com.br Débora Santos]
* [mailto:gabriel.scavassa@mstech.com.br Gabriel Scavassa]
* [mailto:juan.falguera@mstech.com.br Juan Falguera]
* [mailto:lucimara.maiorali@mstech.com.br Lucimara Maiorali]
* [mailto:ricardo.agulhari@mstech.com.br Ricardo Agulhari]
* [mailto:rodrigo.edamatsu@mstech.com.br Rodrigo Edmatsu]

Instalação SonarQube

2016-08-25T17:05:01Z

Gabriel.scavassa: Criou página com ' === Baixar arquivos === === Localização dos arquivos === Extraia os arquivos do SonarQube para C:/SonarQube. Extraia os arquivos do SonarScanner para C:/SonarScanner. =...'

=== Baixar arquivos ===

=== Localização dos arquivos ===

Extraia os arquivos do SonarQube para C:/SonarQube.
Extraia os arquivos do SonarScanner para C:/SonarScanner.

=== Configuração do projeto ===

Para configurarmos o nosso projeto para ser analisado pelo SonarQube precisamos adicionar um arquivo de configuração na raiz da solução (Mesmo nível do .sln).

O arquivo deverá se chamar: '''sonar-project.properties'''. Atenção, este arquivo deverá ser .properties e não .txt.
Este arquivo deverá ter o seguinte conteúdo:

<nowiki># Required metadata
sonar.projectKey=IdentificadorUnicoDoProjeto
sonar.projectName=Nome do Meu Projeto
sonar.projectVersion=1.0.0
# Comma-separated paths to directories with sources(required)
sonar.sources=.
# Languages
sonar.languages=cs
# Ignore
sonar.exclusions=**/packages/**/*</nowiki>

'''sonar.projectKey''' deverá receber um identificador único para o sonar identificar o projeto. Permitido letras, números, hífen, underline, ponto e dois pontos.

'''sonar.projectName''' é o próprio nome do projeto que irá aparecer na lista de projetos do SonarQube.

'''sonar.projectVersion''' é a versão atual do projeto. Ele deve ser atualizado a cada scanner para que um histórico do projeto seja gerado.

'''sonar.sources''' deverá receber o nome da pasta que o SonarQube irá ler. Quando usado ponto após o igual (=.) será feita a leitura em todas subpastas do projeto.

'''sonar.languages''' recebe o tipo da linguagem de programação que ele analisará. Caso não coloque está configuração, será analisado todas as linguagens instaladas no sonarqube.

'''sonar.exclusions''' recebe a lista de arquivos ou pastas que não serão analisados durante a execução.

Exemplos:
Excluir todas as pastas “vendor”, suas subpastas e arquivos:
**/vendor/**/*
Excluir todas as extensões javascript e css:
**/*.js, **/*.css
Excluir uma determinada pasta, subpasta e todos seus arquivos:
src/packages/**/*

Mais informações:

http://docs.sonarqube.org/display/SONAR/Analysis+Parameters

=== Instalações SonarQube ===

==== Manualmente ====

Execute o CMD como administrador.
Navegue até a pasta onde se encontra o executor do SonarQube
Ex: C:\SonarQube\bin\windows-x86-64(32)
Execute o arquivo StartSonar.bat
Neste momento, o site do SonarQube ficará na porta http://localhost:9000/

==== Serviço do Windows ====

Execute o CMD como administrador.
Navegue até a pasta onde se encontra o executor do SonarQube
Ex: C:\SonarQube\bin\windows-x86-64(32)
Para instalar a instalação execute o arquivo
InstallNTService.bat
Para iniciar o serviço, execute o arquivo
StartNTService.bat
Neste momento, o site do SonarQube ficará na porta http://localhost:9000/

Caso precise alterar alguma configuração ou desinstalar execute
StopNTService.bat
UninstallNTService.bat

=== Executar Análise ===

Execute o CMD como administrador.

Navegue até a pasta do projeto onde está o seu .sln junto com seu arquivo de configuração.
EX: cd C:\Projetos\MeuProjeto\src

No mesmo CMD que navegou até a pasta do projeto, execute o Scanner

Para isso dê o caminho até o arquivo sonar-scanner.bat
EX.: C:\SonarScanner\bin\sonar-scanner.bat

Também é possível configurar o sonar scanner como variável ambiente para facilitar a execução.
Para isso acesse Painel de Controle → Sistema e Segurança → Sistema → Configurações avançadas do sistema → Variáveis em Ambiente… → Variáveis do sistema → adicione o caminho até pah asta bin do sonar scanner (ou windows + pause break).

Exemplo: C:\sonarqube\sonar-scanner-2.6.1\bin. Depois de configurado, abra o CMD e execute o comando sonar-scanner.

Após executar o scanner, seu projeto começará a ser analisado. O resultado de saída irá aparecer no site do sonar http://localhost:9000/

=== Possíveis Problemas ===

==== Erro ao executar SonarQube como serviço d windows ====
Quando instalado o SonarQube como um serviço do Windows, ao executar ele buscará por uma pasta temporária em:
C:\Windows\system32\config\systemprofile\AppData\Local\Temp\
Você poderá ver isto no log de erros que ele mostra no CMD ou então no arquivo:
C:/SonarQube/logs/sonar.log
Esta pasta não existe e o Sonar muitas vezes mesmo executando como administrador não consegue/pode criar.
Como solução, você deverá alterar a configuração adicionando uma nova pasta temp:
Pare e desinstale o serviço do SonarQube.
Vá até a pasta de configuração
C:/SonarQube/Conf/wrapper.conf
Comente a linha (#wrapper.java.additional.1=-Djava.awt.headless=true)
Adicione a linha: wrapper.java.additional.1=-Djava.awt.headless=true -Djava.io.tmpdir=C:\SonarQube\temp
Salve e em seguida reinstale e inicie o serviço do SonarQube.

==== Erro de memória ao executar o Sonar Scanner ====

Dependendo das configurações da máquina ou programas em execução, pode acontecer de uma das JVMs darem problema de falta de memória. Pode acontecer durante a execução do sonar scanner ou no momento que o sonarqube está processando os dados para visualizar no site.

Antes de configurar precisamos conhecer rapidamente as JVMs do sonarqube e sonar scanner.
O sonarqube possui:
1 JVM para rodar o servidor web
1 JVM chamada compute engine que é um serviço para processar os dados enviados pelo sonar scanner e enviar para o servidor web.
Enquanto que o sonar scanner possui:
1 JVM que analisa o código baseado nas configurações e plugins existentes, enviando para o sonarqube webserver.

'''Configurando o SonarQube'''
Dentro da pasta do sonarqube acesse a pasta conf e edite o arquivo sonar.properties
Para aumentar a capacidade do servidor web:
remova o comentário "#sonar.web.javaOpts=-Xmx2048m -Xms1024m -XX:+HeapDumpOnOutOfMemoryError -Djava.net.preferIPv4Stack=true"
Para aumentar a capacidade do compute engine:
remova o comentário "#sonar.ce.javaOpts=-Xmx2048m -Xms1024m -XX:+HeapDumpOnOutOfMemoryError -Djava.net.preferIPv4Stack=true"
Salve o arquivo e tente executar novamente.

'''Configurando o Sonar Scanner'''

Dentro da pasta do sonar scanner, acesse a pasta bin e edite o arquivo sonar-scanner.bat

Na linha 76 antes do %JAVA_EXEC% copie e cole o seguinte comando "set SONAR_SCANNER_OPTS=-Xmx512m -XX:MaxPermSize=128m"

Dica: Dependendo da complexidade do projeto, talvez seja necessário aumentar mais do que 512mb da JVM.

== Referências ==
http://docs.sonarqube.org/display/SONAR/Get+Started+in+Two+Minutes
http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner

Instalacao SonarQube

2016-08-25T17:02:20Z

Jenkins + SonarQube

2016-08-08T10:57:58Z

Gabriel.scavassa: /* Ativar o SonarQube Scanner */

== Como configurar ==
=== Plugin no Jenkins ===

Adicione o plugin do sonarqube

SonarQube na versão 2.4.4

=== Configurar o server do SonarQube no Jenkins ===

No Jenkins, vá em Gerenciar Jenkins -> Configurar o Sistema.
Procure o bloco SonarQube servers e preencha os campos

'''Name''': Nome desta instalação

'''Server URL''': URL do SonarQube

'''Server Version''': Default

=== Ativar o SonarQube Scanner ===

Acesse Gerenciar Jenkins -> Global Tool Configuration
Procure o bloco SonarQube Scanner
Este bloco virá desabilitado e temos que configurar duas coisas:

'''Name''': Nome do seu scanner

'''Intall From Maven Central''': Default.

=== Configurando o projeto ===

Navegue até seu projeto no Jenkins e clique em Configurar.
No bloco Build, clique na lista “Adicionar passo no build”.
Selecione o '''Execute SonarQube Scanner'''.

Preencha os campos:

'''Task to run''': Deixe em branco
'''JDK''': ''Inherit From Job''
'''Path to project properties''': Coloque o caminho para o arquivo de configuração do Sonar (sonar-project.properties).
'''Analysis properties''': Caso você preencheu o campo acima, não preencha este. Caso não, coloque aqui o conteúdo do seu arquivo de configuração do sonar.

=== Execução ===

Aparecerá o logo do SonarQube no seu projeto e agora você poderá executar a sua análise de projeto e ver o resultado.
E logo após a execução do Sonar pelo Jenquins você poderá acessar o site do Sonar e ver o resultado do seu projeto.

Jenkins + SonarQube

2016-08-08T10:57:41Z

Gabriel.scavassa: /* Configurar o server do SonarQube no Jenkins */

Jenkins + SonarQube

2016-08-08T10:57:00Z

Gabriel.scavassa: /* Como configurar */

== Como configurar ==
=== Plugin no Jenkins ===

Adicione o plugin do sonarqube

SonarQube na versão 2.4.4

=== Configurar o server do SonarQube no Jenkins ===

No Jenkins, vá em Gerenciar Jenkins -> Configurar o Sistema.
Procure o bloco SonarQube servers e preencha os campos

'''Name''': Nome desta instalação

'''Server URL''': URL do seu SonarQube

'''Server Version''': Default

=== Ativar o SonarQube Scanner ===

Acesse Gerenciar Jenkins -> Global Tool Configuration
Procure o bloco SonarQube Scanner
Este bloco virá desabilitado e temos que configurar duas coisas:

'''Name''': Nome do seu scanner

'''Intall From Maven Central''': Default.

=== Configurando o projeto ===

Navegue até seu projeto no Jenkins e clique em Configurar.
No bloco Build, clique na lista “Adicionar passo no build”.
Selecione o '''Execute SonarQube Scanner'''.

Preencha os campos:

'''Task to run''': Deixe em branco
'''JDK''': ''Inherit From Job''
'''Path to project properties''': Coloque o caminho para o arquivo de configuração do Sonar (sonar-project.properties).
'''Analysis properties''': Caso você preencheu o campo acima, não preencha este. Caso não, coloque aqui o conteúdo do seu arquivo de configuração do sonar.

=== Execução ===

Aparecerá o logo do SonarQube no seu projeto e agora você poderá executar a sua análise de projeto e ver o resultado.
E logo após a execução do Sonar pelo Jenquins você poderá acessar o site do Sonar e ver o resultado do seu projeto.

Jenkins + SonarQube

2016-08-08T10:55:13Z

Gabriel.scavassa: /* Como configurar */

== Como configurar ==
### Plugin no Jenkins ###

Adicione o plugin do sonarqube

SonarQube na versão 2.4.4

### Configurar o server do SonarQube no Jenkins ###

No Jenkins, vá em Gerenciar Jenkins -> Configurar o Sistema.
Procure o bloco SonarQube servers e preencha os campos

'''Name''': Nome desta instalação

'''Server URL''': URL do seu SonarQube

'''Server Version''': Default

### Ativar o SonarQube Scanner ###

Acesse Gerenciar Jenkins -> Global Tool Configuration
Procure o bloco SonarQube Scanner
Este bloco virá desabilitado e temos que configurar duas coisas:

'''Name''': Nome do seu scanner

'''Intall From Maven Central''': Default.

### Configurando o projeto ###

Navegue até seu projeto no Jenkins e clique em Configurar.
No bloco Build, clique na lista “Adicionar passo no build”.
Selecione o '''Execute SonarQube Scanner'''.

Preencha os campos:

'''Task to run''': Deixe em branco
'''JDK''': ''Inherit From Job''
'''Path to project properties''': Coloque o caminho para o arquivo de configuração do Sonar (sonar-project.properties).
'''Analysis properties''': Caso você preencheu o campo acima, não preencha este. Caso não, coloque aqui o conteúdo do seu arquivo de configuração do sonar.

### Execução ###

Aparecerá o logo do SonarQube no seu projeto e agora você poderá executar a sua análise de projeto e ver o resultado.
E logo após a execução do Sonar pelo Jenquins você poderá acessar o site do Sonar e ver o resultado do seu projeto.

Boas Praticas Programacao

2016-07-13T18:09:36Z

Gabriel.scavassa: /* Comentário */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitam para a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso
// Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser(){...}</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T18:07:47Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso
// Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser(){...}</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T18:07:32Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code>
// Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso
// Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser(){...}</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T18:07:16Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso
// Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser(){...}</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T18:07:03Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso
// Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser(){...}</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T18:06:49Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso // Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser(){...}</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T18:01:20Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso
// Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser(){...}</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T17:42:27Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso
// Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser(){...}</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T17:41:32Z

Gabriel.scavassa: /* Comentário */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso
// Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser(){...}</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T17:41:00Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code>
// Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso
// Os cursos que este usuário irá participar deverão estar como status 1
// As turmas dos cursos tem um tutor com o status igual a 19
// Os cursos tem que iniciar em setembro e não podem começar com a letra N
// Parece que os usuários que vao fazer o curso não estão com notas no módulo B
// Todos os cursos tem que fazer parte no ano letivo atual
// não podem ser semestrais, pois os alunos tem inscrição anual
// Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos
// Os cursos tem Flash: e quando não tiver suporte pra flash ?
public void EnrollUser()
</code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T17:37:05Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso </code>

<code> // Os cursos que este usuário irá participar deverão estar como status 1 </code>

<code> // As turmas dos cursos tem um tutor com o status igual a 19 </code>

<code> // Os cursos tem que iniciar em setembro e não podem começar com a letra N </code>

<code> // Parece que os usuários que vao fazer o curso não estão com notas no módulo B </code>

<code> // Todos os cursos tem que fazer parte no ano letivo atual </code>

<code> // não podem ser semestrais, pois os alunos tem inscrição anual </code>

<code> // Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos </code>

<code> // Os cursos tem Flash: e quando não tiver suporte pra flash ? </code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T17:36:40Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

*Explicações longas
<code> // Este método irá realizar uma comparação para contas de usuário que estão aptos a realizar um curso </code>
<code> // Os cursos que este usuário irá participar deverão estar como status 1 </code>
<code> // As turmas dos cursos tem um tutor com o status igual a 19 </code>
<code> // Os cursos tem que iniciar em setembro e não podem começar com a letra N </code>
<code> // Parece que os usuários que vao fazer o curso não estão com notas no módulo B </code>
<code> // Todos os cursos tem que fazer parte no ano letivo atual </code>
<code> // não podem ser semestrais, pois os alunos tem inscrição anual </code>
<code> // Os cursos tem vídeo: verificar se o usuário tem acesso a pagina de videos </code>
<code> // Os cursos tem Flash: e quando não tiver suporte pra flash ? </code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T17:30:44Z

Gabriel.scavassa: /* Sumário */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

=== Sumário ===

Adicionar Summary auxilia o desenvolvedor que irá consumir este método orientando sobre a finalidade, parâmetros e retorno.

Para API's públicas, o sumário é muito importante, pois provê informações para a construção de helpers.

Boas Praticas Programacao

2016-07-13T17:22:18Z

Gabriel.scavassa: /* Comentário */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''"Uma das motivações mais comuns para criar comentários é um código ruim."'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

=== Sumário ===

Boas Praticas Programacao

2016-07-13T17:22:00Z

Gabriel.scavassa: /* Comentário */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.

''Uma das motivações mais comuns para criar comentários é um código ruim.'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

=== Sumário ===

Boas Praticas Programacao

2016-07-13T17:21:42Z

Gabriel.scavassa: /* Comentário */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o."'' Brian Kernighan e P.J. Plaugher.
''Uma das motivações mais comuns para criar comentários é um código ruim.'' Robert C. Martin.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

=== Sumário ===

Boas Praticas Programacao

2016-07-13T17:20:24Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o"'' Brian Kernighan e P.J. Plaugher.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>

<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

=== Sumário ===

Boas Praticas Programacao

2016-07-13T17:20:09Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o"'' Brian Kernighan e P.J. Plaugher.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome </code>
<code>string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

=== Sumário ===

Boas Praticas Programacao

2016-07-13T17:19:46Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o"'' Brian Kernighan e P.J. Plaugher.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code>// Nome
string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

=== Sumário ===

Boas Praticas Programacao

2016-07-13T17:19:16Z

Gabriel.scavassa: /* Comentários no código */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o"'' Brian Kernighan e P.J. Plaugher.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code> // /* não apague!!!!!! */</code>

*Para parâmetros ou métodos auto explicativos.
<code> // Nome
string nome;</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

=== Sumário ===

Boas Praticas Programacao

2016-07-13T17:18:34Z

Gabriel.scavassa: /* Comentário */

Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH.

== Utilizando camelCasing e PascalCasing ==

Os projetos em .Net na MSTECH devem adotar o [https://msdn.microsoft.com/en-us/library/ms229043.aspx padrão de maiúsculas] criados pela equipe da Microsoft.

=== camelCasing ===

O camelCasing consiste em tornar maiúscula todas as primeiras letras das palavras com exceção da primeira palavra.

EX: camelCasing, existeTitulo, idEscola ...

Utilize este padrão para variáveis e parâmetros. Quando a variável ou parâmetro possuir um acrônimo, utilizar as duas primeiras letras também minusculas.

=== PascalCasing ===

O PascalCasing consiste em tornar maiúscula toda primeira letra das palavras.

Ex: SalvarUsuario() e LoginExterno ...

Utilize este padrão para nome de métodos e propriedades de uma entidade.

=== Exemplos ===

{| class="wikitable"
|-
! Identificador
! Caso
! Exemplo
|-
| Namespace
| Pascal
| <code> namespace System.Security { ... }</code>
|-
| Tipo
| Pascal
| <code> public class StreamReader {...}</code>
|-
| Interface
| Pascal
| <code> public interface IEnumerable {...} </code>
|-
| Método
| Pascal
| <code> public class Object{ public virtual Length{ get; } } </code>
|-
| Propriedade
| Pascal
| <code> public class Process {public event EventHandler Exited;}</code>
|-
| Campo
| Pascal
| <code> public class MessageQueue {public static readonly TimeSpan InfiniteTimeout;} public struct UInt32 { public const Min = 0; } </code>
|-
| Valor do Enum
| Pascal
| <code> public enum FileMode { Append,...}</code>
|-
| Parâmetro
| Camel
| <code> public static int ToInt32(string value); </code>
|}

== Criação de nomes ==

O objetivo é normalizar a criação de nomes para variáveis, tipos, métodos...

=== Regras gerais ===

* O projeto deve ser desenvolvido utilizando uma linguagem ubiquá.
* Crie variáveis e métodos com nomes claros e não extensos.
* Não utilize nomes genéricos. Exemplo: <code> var teste; </code>
* Não utilize acentos nos nomes.
* Evite criar nomes que denotem negação. Exemplo: <code> bool usuarioNaoInscrito = true; if(!usuarioNaoInscrito){...} </code>

=== Variáveis ===
* Utilize camelCasing.
* Recomendado o uso de plural para variáveis que armazenem coleções.
* Recomendado a utilização de sufixos para booleanos. Exemplo : <code> bool emEdicao = false; </code>

=== Métodos, classes e interfaces ===
* Utilize PascalCasing.
* Utilize o prefixo I para Interfaces.

== Comentário ==

Os comentários em código devem ser mínimos. O seu próprio código deve ser auto descritivo. Quando nos deparamos com um código que precisa de muito comentário para explicar o seu funcionamento, reveja a forma como está a lógica deste código, tente separar em partes menores, com métodos que possuam nomes claros, inteligíveis e que executem ações específicas.

Os comentários '''devem''' sofrer manutenção assim como o código, para que eles não atrapalhem um novo membro da equipe a entender o que está ocorrendo no código.

''"Não insira comentários num código ruim, reescreva-o"'' Brian Kernighan e P.J. Plaugher.

=== Comentários no código ===
Boa prática:

* Comentário em parâmetros retornados por programas externos (API's, por exemplo).
* Destacar a utilização de um método importante que pode parecer desnecessário.
* TODO: Existem casos onde adicionar comentários TODO facilitem a revisões de código.

Evite:
*Comentar trechos de código: Deixe que o versionamento de código faça isto por você.
<code>
// /* não apague!!!!!! */
</code>

*Para parâmetros ou métodos auto explicativos.
<code>
// Nome
string nome;
</code>

*Explicações desnecessárias.
<code> // Esta é melhor solução que o Fulano tentou, não sei se ele pesquisou a página XYZ.com </code>

=== Sumário ===

Boas Praticas Programacao

2016-07-13T17:08:20Z

Gabriel.scavassa:

Boas Praticas Programacao

2016-07-05T15:25:24Z

Gabriel.scavassa:

Boas Praticas Programacao

2016-07-04T17:01:51Z

Gabriel.scavassa:

Boas Praticas Programacao

2016-07-04T17:01:34Z

Gabriel.scavassa:

Boas Praticas Programacao

2016-07-04T16:44:05Z

Gabriel.scavassa:

Boas Praticas Programacao

2016-07-04T16:17:24Z

Gabriel.scavassa: Criou página com ' Esta página serve com uma referência para a convenção de código e consulta para eventuais divergências entre modelos adotados na MSTECH. == Utilizando camelCasing e P...'

Cursos de programação

2016-06-30T14:24:34Z

Gabriel.scavassa: /* Boas praticas para melhorar performance no navegador */

== Code Academy ==
http://www.codecademy.com
Possui cursos em português
Cursos de javascript

=== Curso HTML & CSS ===
Duração: 7h
http://www.codecademy.com/tracks/web

=== Curso Javascript ===
Duração: 10h
http://www.codecademy.com/tracks/javascript

=== Curso JQuery ===
Duração: 3h
http://www.codecademy.com/tracks/jquery

=== Make a Website ===
Duração: 3h
http://www.codecademy.com/en/skills/make-a-website

=== Make na Interactive Website ===
Duração: 5h
http://www.codecademy.com/skills/make-an-interactive-website

== Code School ==
https://www.codeschool.com/
Cursos interessantes para os iniciantes e para reciclagem das pessoas:

=== Path Html/Css ===
https://www.codeschool.com/paths/html-css

=== Path Javascript ===
https://www.codeschool.com/paths/javascript

=== Path Electives ===
https://www.codeschool.com/paths/electives

=== Git ===
https://www.codeschool.com/paths/git

=== JAVASCRIPT BEST PRACTICES ===
https://www.codeschool.com/courses/javascript-best-practices

=== DISCOVER DEVTOOLS ===
https://www.codeschool.com/courses/discover-devtools

=== Try Git ===
https://www.codeschool.com/courses/try-git

== Microsoft Virtual Academy ==
A maioria possui legenda em português.
http://www.microsoftvirtualacademy.com/

=== Conceitos básicos do desenvolvimento de software ===
http://www.microsoftvirtualacademy.com/training-courses/software-development-fundamentals_ptb
http://www.microsoftvirtualacademy.com/training-courses/fundamentos-do-desenvolvimento-de-software

=== Jump Start sobre construção de Web Apps com ASP.NET ===
http://www.microsoftvirtualacademy.com/training-courses/jump-start-sobre-constru-o-de-web-apps-com-asp-net

=== Conceitos básicos de bancos de dados ===
http://www.microsoftvirtualacademy.com/training-courses/database-fundamentals_ptb

=== Introdução rápida ao desenvolvimento em HTML5 com JavaScript e CSS3 ===
http://www.microsoftvirtualacademy.com/training-courses/90f7eb67-0c78-44b5-90b6-43bca793bb14

=== Single Page Applications with jQuery or AngularJS ===
http://www.microsoftvirtualacademy.com/training-courses/single-page-applications-with-jquery-or-angularjs

== Diversos ==
http://www.learnjavaonline.org/
http://www.learnpython.org/
http://www.learncs.org/
http://www.learn-js.org/
http://www.learnshell.org/

== Code Combat ==
http://codecombat.com/
Curso onde você pode escolher uma das linguagens de programação (javascript, python, etc) para completar os desafios em forma de jogo.
Em inglês.

== CSS Diner ==
http://flukeout.github.io/
Desafios de CSS com temática culinária
Em inglês

== Boas praticas para melhorar performance no navegador ==
https://browserdiet.com/pt/ Guia de boas praticas que ajudam na performance do navegador melhorando a experiência do usuário.

Cursos de programação

2016-06-30T14:23:29Z

Gabriel.scavassa: