imbajin commented on code in PR #2480: URL: https://github.com/apache/incubator-hugegraph/pull/2480#discussion_r1527161921
########## hugegraph-pd/hg-pd-common/src/main/java/org/apache/hugegraph/pd/common/Useless.java: ########## @@ -0,0 +1,31 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hugegraph.pd.common; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * The "Useless" annotation indicates that the annotated object can be safely removed without + * affecting existing functionality, including objects that are only referenced in tests. + */ +@Target({ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE}) +@Retention(RetentionPolicy.SOURCE) +public @interface Useless {} Review Comment: ```suggestion public @interface Useless { String value() default "Remove or handle it later"; } ``` Better to add a default value for the annotation, so that we could set the "note" if we need ```java @Useless("This method will be merged in 2,0") public void someMethod() { // confused code } ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
