Versão JavaDoc do C# e "regras" a usar em c#

[Saco]

Pergunta nº1 - Não existe nada para C# que se assemelhe ao JavaDoc do java? Já vi aqui o .NET Framework Class Browser... não está nada mau mas não tem documentação relativamente aos métodos (o que é que retorna, o que significa cada argumento, etc).

Pergunta nº2 - Em Java existem muitas "regras de conduta" - como os nomes das variáveis globais serem precedidos de _, os nomes dos métodos começarem por letra minuscula (excepto o do construtor...), os nomes das classes por letra maiúscula, etc etc. Em C# não existem estas mariquices?

PS: já deve ter dado para perceber que comecei por aprender C e Java e agora estou a aproveitar para juntar o melhor de dois mundos (teoricamente).

[Hipnoted]

Em C# não existem estas mariquices?

Podem ser mariquices, mas o certo é que ajuda muito na percepção e reutilização do código.

Quanto às tuas perguntas, também gostava de saber. 😛

[SoulOnFire]

Pergunta nº1 - Não existe nada para C# que se assemelhe ao JavaDoc do java? Já vi aqui o .NET Framework Class Browser... não está nada mau mas não tem documentação relativamente aos métodos (o que é que retorna, o que significa cada argumento, etc).

Pergunta nº2 - Em Java existem muitas "regras de conduta" - como os nomes das variáveis globais serem precedidos de _, os nomes dos métodos começarem por letra minuscula (excepto o do construtor...), os nomes das classes por letra maiúscula, etc etc. Em C# não existem estas mariquices?

PS: já deve ter dado para perceber que comecei por aprender C e Java e agora estou a aproveitar para juntar o melhor de dois mundos (teoricamente).

Para resposta á tua 1ª pergunta, so preciso de saber uma coisa... o k keres é documentar os teus metodos?? ou keres ver os comentarios dos existentes na framework??

Para a 2ª a unica "mariquice" é mesmo o "case sensitive"  é claro k por exemplo eu kuando estou uma Solução  k envolva vários projectos (como é o caso neste momento 71 projectos numa solução unica - granda maluco), uso regras especificas mas impostas por mim, tipo variaveis internas precedidas de _ e tal e coisa.

é claro k se tiveres acesso ao Visual Studio 2005 Team System (http://msdn.microsoft.com/vstudio/teamsystem/products/default.aspx), tem uma coisa chamade de Visual Studio Managed Code Analysis (FxCop) k podes encontrar aki http://blogs.msdn.com/fxcop/default.aspx... é uma ferramenta muito interessante que te permite fazer testes verificar código etc...etc..etc!!!!

Espero k te sirva de alguma coisa!!!

kk duvida já sabes!!

[Saco]

Quero mesmo a documentação dos métodos existentes na framework... documentar os meus também seria interessante, mas pode-se dispensar.

E quando falei de "mariquices" foi só uma maneira de falar, porque são realmente regras muito úteis.

[M6]

NDoc rules. 😛

[shumy]

Como assim!? Isto: http://msdn2.microsoft.com/en-us/library/ms229335.aspx

[Evil Knievel]

NDoc rules. 🙂

  🙂

FxCop Rules  ?

[http://www.gotdotnet.com/Team/FxCop/]

About FxCop

FxCop is a code analysis tool that checks .NET managed code assemblies for conformance to the Microsoft .NET Framework Design Guidelines. It uses reflection, MSIL parsing, and callgraph analysis to inspect assemblies for more than 200 defects in the following areas:

    * Library design

    * Localization

    * Naming conventions

    * Performance

    * Security

FxCop includes both GUI and command line versions of the tool.

Download FxCop 1.35

FxCop 1.35 Requires .NET 2.0 to run and is able to analyze assemblies compiled against all versions of the .NET Runtime.

    * FxCop self-extracting installer (3.78 MB, 06/23/06)

    * FxCop .msi installer (3.61 MB, 06/23/06)

FxCop ships under the Microsoft FxCop EULA.

Documentation

    * FxCop 1.32 Readme

    * Online documentation (v1.32.0, 3/15/05)

    * FxCop.chm download (2 MB, v1.32.0, 3/15/05)

FxCop User Samples

We have received lots of requests to create a place for FxCop users to share custom rules, XSL's, and other handy tools related to FxCop. You can share your contributions via the special FxCop area within GotDotNet User Samples.

FxCop Support

The best place to go for support is the FxCop Managed Code Analysis forum. Here an active community of FxCop users, as well as Microsoft's FxCop Team, help people with questions on FxCop.

[Guest id194]

1) A MSDN Library tem toda a documentação possivel para todas as classes, metodos whatever do .NET e com exemplos de código em VB.NET, C#, VC++, etc... Se andas na universidade e tens o protocolo MSDNAA, tens lá isso para download. Se não, tens de ter uma subscrição na MSDN ou coisas parecida acho eu. No entanto, a Microsoft costuma disponibilizar em download público algumas versões da MSDN Library, mas versões + antigas. Não sei se é isso que pretendes, mas suponho que sim... Ou então tens versão online (http://msdn2.microsoft.com/en-us/library/default.aspx), mas recomendo ter uma instalado porque podes integrar com o VS e tem funções de procura dinâmica, conforme escreves código, recebes sugestões de tópicos que podes estar interessado.

2) Essas regras de conduta no java são obrigatórias? Ou seja, se não precederes uma variável global por _, o programa funciona na mesma ou não? Regras desse tipo, obrigatórias onde o programa não funcione se não as aplicares, acho que não existem (pelo menos desse genero), no entanto existe as convenções de código. Mas isso cabe a ti decidir se as queres usar ou não... Por exemplo: http://www.csharpfriends.com/Articles/getArticle.aspx?articleID=336

[Knitter]

Dado que já se respondeu à regra 1 o suficiente deixo duas correcções/indicações para a regra dois...

Uma variável global não deve começar por underscore! Isso está nas regras do Java 🙂 , e  no caso do C# as regras usadas são as do Pascal, na generalidade dos casos e a regras Camel no caso dos nomes dos parametros de entrada dos métodos.

Isso são apenas regras de conduta, que recomendo vivamente que sigam, ajuda bastante, e falo por experiência, embora possam encontrar situações onde usem outras regras, mas usem sempre regras.

E um programa em Java, ou noutra linguagem, onde as convenções de código não sejam respeitadas funciona perfeitamente. Desde que não violem as regras da próprias linguagem e apenas as de codificação.