JAV-57 added javadocs to help readers understand the code

worker/src/main/java/io/servicecomb/company/worker/FibonacciEndpoint.java

@@ -15,7 +15,35 @@
  */
 package io.servicecomb.company.worker;
 
+/**
+ * {@link FibonacciEndpoint} provides the common interface for different endpoint implementations,
+ * such as {@link FibonacciRestEndpoint} and {@link FibonacciRpcEndpoint}.
+ *
+ * It supports sequence up to roughly 90, because the sequence value will exceed the limit of Java
+ * type long.
+ *
+ * The endpoints are supposed to be very thin. They parse requests from different protocols and
+ * delegate them to the same calculation logic provided by {@link FibonacciService}.
+ */
 public interface FibonacciEndpoint {
 
+  /**
+   * Calculates the nth term of fibonacci sequence.
+   * for example, the following statement outputs fibonacci sequence [0, 1, 1, 2, 3, 5]
+   * <pre>
+   *   {@code long[] sequence = {
+   *      endpoint.term(0),
+   *      endpoint.term(1),
+   *      endpoint.term(2),
+   *      endpoint.term(3),
+   *      endpoint.term(4),
+   *      endpoint.term(5)};
+   *   System.out.println(Arrays.toString(sequence));
+   *   }
+   * </pre>
+   *
+   * @param n the index of fibonacci sequence
+   * @return the nth term of fibonacci
+   */
   long term(int n);
 }

worker/src/main/java/io/servicecomb/company/worker/FibonacciRestEndpoint.java

@@ -22,6 +22,10 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.ResponseBody;
 
+/**
+ * {@link FibonacciRestEndpoint} provides the rest implementation of {@link FibonacciEndpoint}.
+ * The rest endpoint is accessed by /fibonacci/term?n={value} with HTTP GET.
+ */
 @RestSchema(schemaId = "fibonacciRestEndpoint")
 @RequestMapping("/fibonacci")
 @Controller

worker/src/main/java/io/servicecomb/company/worker/FibonacciRpcEndpoint.java

@@ -19,7 +19,9 @@
 import io.servicecomb.provider.pojo.RpcSchema;
 import org.springframework.beans.factory.annotation.Autowired;
 
-
+/**
+ * {@link FibonacciRpcEndpoint} provides the RPC implementation of {@link FibonacciEndpoint}.
+ */
 @RpcSchema(schemaId = "fibonacciRpcEndpoint")
 // class modifier has to be public, or producer invoker will fail to access it
 public class FibonacciRpcEndpoint implements FibonacciEndpoint {

worker/src/main/java/io/servicecomb/company/worker/FibonacciService.java

@@ -1,4 +1,4 @@
-package io.servicecomb.company.worker;/*
+/*
  * Copyright 2017 Huawei Technologies Co., Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,8 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+package io.servicecomb.company.worker;
 
+/**
+ * {@link FibonacciService} provides the interface of actual fibonacci sequence calculation.
+ */
 interface FibonacciService {
 
+  /**
+   * @see FibonacciEndpoint#term(int)
+   * @param n the index of fibonacci sequence
+   * @return the nth term of fibonacci sequence
+   */
   long term(int n);
 }

worker/src/main/java/io/servicecomb/company/worker/FibonacciServiceImpl.java

@@ -20,6 +20,9 @@
 @Service
 class FibonacciServiceImpl implements FibonacciService {
 
+  /**
+   * {@inheritDoc}
+   */
   @Override
   public long term(int n) {
     if (n < 0) {

worker/src/main/java/io/servicecomb/company/worker/WorkerApplication.java

@@ -27,6 +27,8 @@ public static void main(String[] args) {
     SpringApplication.run(WorkerApplication.class, args);
   }
 
+  // do not enable service registration/discovery and schema generation/registration
+  // unless the active profile is not dev
   @EnableServiceComb
   @Profile("!dev")
   class ServiceCombConfig {