You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@dubbo.apache.org by "chenlushun (GitHub)" <gi...@apache.org> on 2018/12/04 14:01:23 UTC

[GitHub] [incubator-dubbo] chenlushun commented on issue #2884: We need more code comments

I recommend that when you write comments, you change lines in the right place so that it's easy to read. The following comments needs to slide.
```java
/**
     * Register data, such as : provider service, consumer address, route rule, override rule and other data.
     * <p>
     * Registering is required to support the contract:<br>
     * 1. When the URL sets the check=false parameter. When the registration fails, the exception is not thrown and retried in the background. Otherwise, the exception will be thrown.<br>
     * 2. When URL sets the dynamic=false parameter, it needs to be stored persistently, otherwise, it should be deleted automatically when the registrant has an abnormal exit.<br>
     * 3. When the URL sets category=routers, it means classified storage, the default category is providers, and the data can be notified by the classified section. <br>
     * 4. When the registry is restarted, network jitter, data can not be lost, including automatically deleting data from the broken line.<br>
     * 5. Allow URLs which have the same URL but different parameters to coexist,they can't cover each other.<br>
     *
     * @param url  Registration information , is not allowed to be empty, e.g: dubbo://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0&application=kylin
     */
    void register(URL url);
```

[ Full content available at: https://github.com/apache/incubator-dubbo/issues/2884 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org