Skip to main content

Experimental comments for Dart API docs

Posted by Seth Ladd

In an effort to help capture tips and clarifications of our API docs, we've just turned on an experimental comment system for api.dartlang.org. We invite the community to help build out a great documentation resource for Dart.

We will moderate the comments heavily, ensuring only actual clarifications, examples, tips, etc remain. We will moderate and possibly delete comments that do not directly assist other users of the API docs. The API doc comments are not the place for:

  • Bugs (please use dartbug.com)
  • Support questions (please use StackOverflow)
  • Discussions (please use misc@dartlang.org)
  • Spam
  • Notes in languages other than English (because we can't moderate those effectively)
  • Links to other websites
The API doc comments are the perfect place for:
  • Snippets showing best practice usage of the API
  • Clarifications of the API
  • Example code using the API
Because we may incorporate information from comments into the documentation, any comment submitted here is under the same license as the documentation.

With your help, this experiment will help you share your experience with the API so that others may have an easier time getting started with Dart.

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).

A stronger Dart for everyone

We are constantly asking ourselves:
How do we make developers even more productive when writing Dart apps? We believe that a critical part of the answer to this question is to make strongmode – a sound static type system for Dart – the standard for all Dart developers.

Teams that use Dart to build apps like Soundtrap, AdWords, AdSense, and Greentea say they really enjoy using strong mode features, such as early error detection. In fact, teams that have switched completely to strong mode cite not only early error detection but also better code readability and maintainability as major benefits. We hear this both from small teams and Рeven more so Рfrom large teams with hundreds of developers writing and maintaining millions of lines of Dart code. As Björn Sperber from Soundtrap says,
Strong mode and the smooth integration with IntelliJ is a joy to use and a huge improvement. If you’ve tried out Flutter, you’ve already used strong mode checks from the Dart analyzer.

Given the benefits …

AngularDart 3.0: Easy upgrade, better performance

AngularDart 3.0 is now available. It brings better performance and smaller generated code, while also making you more productive.


Version 3.0 is an evolution: although it has some breaking changes (detailed below), it is a smooth upgrade due to minimal public API adjustments. Most of the progress is under the hood—in code quality, stability, generated code size, performance, and developer experience.

Code quality:
2731 instances of making the framework code more type safe (using sound Dart).The AngularDart framework code size is down by 12%.Many additional style updates to the codebase:Changed to use idiomatic <T> for generic methods.Removed NgZoneImpl, all the code exists in NgZone now.Stability:
Many CSS encapsulation fixes due to update with csslib package.Fixed bugs with IE11.

Performance:
For the Mail sample app, we see 30% faster time-to-interactive (currently 3812 ms on a simulated 3G connection, measured via Lighthouse).Our large app benchmark shows 2x faster render times of…