Skip to content

DocumentPublicBindings

Googler edited this page Oct 15, 2020 · 1 revision

Document the public bindings provided by modules

To document a Guice module, a good strategy is to describe the public bindings that that module installs, for example:

/**
 * Provides {@link FooServiceClient} and derived bindings.
 *
 * [...]
 *
 * <p>The following bindings are provided:
 *
 * <ul>
 *   <li>{@link FooServiceClient}
 *   <li>{@link FooServiceClientAuthenticator}
 * </ul>
 */
public final class FooServiceClientModule extends AbstractModule {
  // ...
}
Clone this wiki locally