Comments on: Why I don’t write code comments

By: Documentação Ágil « Software e Empreendedorismo – Valores, princípios e práticas

Thu, 21 Oct 2010 14:45:31 +0000

[...] precisam ser documentados porque eles são desnecessariamente complexos. Sempre que possível prefira refatorar o código para ele ficar mais fácil de entender ao invés de escrever comentário… (até porque muitas vezes o código muda e o comentário fica lá desatualizado, e isso acaba mais [...]

By: Alguns pensamentos sobre “documentação ágil” | Guilherme Chapiewski

Thu, 23 Sep 2010 14:52:22 +0000

By: Watch out for TODO comments! « Alexandre Gazola

Watch out for TODO comments! « Alexandre Gazola — Fri, 03 Sep 2010 03:21:51 +0000

[...] to try to keep yourself from adding TODO comments to your source code in the first place (in fact, this applies to code comments in general); but, if you do, make sure you don’t forget about them (Eclipse has a “Tasks [...]

By: Guilherme Chapiewski

Guilherme Chapiewski — Thu, 12 Aug 2010 22:19:55 +0000

Your “IsReadyToBeApprovedByAccountManager” example is really ugly, but take a look at the following examples:

Order order = anOrder().from(aCustomer().with(anAddress().withNoPostcode())).build();

(from Nat Pryce blog)

describe("Jasmine", function() {
  it("makes testing JavaScript awesome!", function() {
    expect(yourCode).toBeLotsBetter();
  });
});

(from Jasmine project)

Take a look also at this article I wrote some years ago about a refactoring to use Fluent Intrefaces (in Portuguese).

The effort to make your code readable and easy is always worthwhile.

You can write good, solid, semantic, easy-to-understand, readable, clean code, OR you can continue writing code like this (and you will need tons of documentation, of course): http://vimeo.com/9981123

By: Tomamais

Tomamais — Thu, 12 Aug 2010 19:29:44 +0000

You always should “talk” with your code, but talk in human languange, as posible it is. In simple cases as a mail sender, its very easy to use this philosophy, but not when we need a complex business logic. Can you imagine a method like “Order.IsReadyToBeApprovedByAccountManager()”?

When language code is not sufficient to be clear by itsel, the best way is put comments around code. But not a comment like a book history ok? Leave this do Word Documents.

Sorry for my english

By: Louco por automatização! « Pedro Augusto Freitas de Souza

Louco por automatização! « Pedro Augusto Freitas de Souza — Sat, 03 Apr 2010 03:53:03 +0000

[...] “Radical” e “extremo” são palavras que têm uma conotação muito negativa, mas ser radical ou extremo pode ser muito útil quando se tem um propósito como esse (ou então para se fazer uma abordagem como a que eu postei sobre porque eu não gosto de escrever comentários no código). [...]

By: Guilherme Chapiewski

Guilherme Chapiewski — Fri, 04 Dec 2009 07:45:35 +0000

@Anderson

Sorry, it’s not implemented. But the good thing is that it is Open Source, you can do it if youwant to! I’ll be happy to integrate your patch into the project

By: Anderson

Anderson — Tue, 24 Nov 2009 13:46:07 +0000

How can I use the “no-reply”?

I’ve expected a “.replyTo(…)” !

By: Louco por automatização! | Planeta Globo.com

Louco por automatização! | Planeta Globo.com — Wed, 15 Apr 2009 22:12:49 +0000

By: Louco por automatização! | Guilherme Chapiewski

Louco por automatização! | Guilherme Chapiewski — Wed, 15 Apr 2009 06:13:22 +0000