Skip to main content

Updates to Dart style guide

Posted by Bob Nystrom


Just a quick note that I've updated the Dart style guide on dartlang.org. The changes mostly reflect practices we've already adopted internally, but it's good to write them down so we can try to be as consistent as possible. While coding style is an eternal holy war, I think most of us agree that having a single style that the community uses makes it easier for all of us to share, reuse, and extend code.

Use ";" for empty constructors. This is required for const constructors. So, to be consistent, we use this for all empty constructors (which are pretty common thanks to initializing formals).

Place the super() call last in initialization lists. Dart lets you put it anywhere, but it always gets invoked after the other fields are initialized. Placing it last makes that visually consistent.

Prefer type annotating public APIs. Most of us seem to naturally do this anyway, so this just codifies that. You don't *have* to type annotate all over the place in Dart, but it seems like many of us feel you get the most value out of the language by using types at your API boundaries.

Do not type annotate locals. Conversely, we don't see a lot of value in annotating local variables. Methods tend to be pretty short in modern code and the type of a local is almost always obvious from the initializer. Also, the editor will now do type inference of locals variables declared using var, so you still get the auto-complete you know and love.

Don't use "double" as a type annotation. It doesn't mean what you think. Use "num". If it was up to me, I would just get rid of the "double" type completely, but avoiding it is the next best thing.

Don't type annotate initializing formals. "Initializing formals" are the "this." thing you can do with constructor parameters to initialize a field. Since the field already likely has a type annotation, it's redundant to have it here too.

Don't annotate function expressions. Function expressions are usually short and their terseness is what's nice about it. Adding unnecessary type annotations just clutters it up. This seems to be what we do in practice anyway.

Name libraries and source files using lowercase_with_underscores. This ensures that they are valid identifiers, which may come in handy if we move to an identifier-based #import syntax.

Clarify spacing of "is !". Our repo has a mixture of "is! Foo" and "is !Foo". The latter wins by about a factor of two, and is also consistent with the other spacing rules.

Constructor initialization list formatting. Existing code is all over the place here and no style seems to make initialization lists particularly beautiful, but at least picking one style makes them consistent.

Spacing for "{", "}" and named arguments (":" and "="). The style guide didn't say how things like empty maps should appear ("{}" or "{ }"). Now it does.

Not exactly a super exciting development in the world of Dart, but I think little stuff like this can help make Dart code easier to work with, and that in turn makes it easier for our community to grow.

Cheers!

Popular posts from this blog

Dart in 2016: The fastest growing programming language at Google, 2nd fastest growing in TIOBE Index

Dart was the fastest growing programming language at Google in 2016 with millions of lines of code written. It also made it to TIOBE Index Top 20 this month (see TIOBE's methodology).

It takes time to build something as ambitious as Dart and, in some ways, Dart is still in its infancy. But we're glad the hard work is starting to pay off.

Many thanks to our amazing community!

We're going to celebrate by ... releasing 1.22 next week (as per our usual 6 week release schedule).

The new Google AdSense user interface: built with AngularDart

AdSense is a free, simple way to earn money by placing ads on your website. The team just launched a completely new version of their app for publishers. Read all about it here. We asked Daniel White, the tech lead for the project, some questions because the new UI happens to be built with Dart and Angular2.


AdSense launched way back in 2003. How long is it since the last big redesign?
Last big redesign was called ‘AdSense 3’ and launched about 6 years ago. It was written in Google Web Toolkit (GWT) and the UI has evolved through several iterations - but this is the first ground-up redesign in 6 years. There are a number of long-standing UX issues that we’ve taken the opportunity to solve. A big shout-out to our UX team who’ve been 100% behind this project. We couldn’t have done it without them!

How many software engineers worked on the project?
Purely on the AdSense applications, we have a team of close to 100. Around 25% of them write Dart.

How many lines of code?
We have around 160K LO…

AngularDart 2.1 and new Components

AngularDart got its own dedicated team 5 months ago. Last month, we launched 2.0 final on the Dart Developer Summit. Today, we’re releasing the first minor release after that: 2.1.

Since the focus of AngularDart is Productivity, Performance, Stability, there are no major breaking changes (see the changelog) — but a lot of behind-the-scenes improvements. Your apps will get slightly smaller and faster (even relative to 2.0 which already made huge strides in size and performance since the compiled-from-TypeScript days).

Many features that AngularJS had to implement for JavaScript and TypeScript are not needed in Dart (because Dart already has those features out-of-the-box). So we’re removing them from AngularDart. Renderer is deprecated in favor of plain-old dart:html. NgPlural is going away — Dart programs can use the package:intl library.

New components

On the Dart Developer Summit, we launched AngularDart Components — the material design widgets Google is using in customer-facing apps …