메서드가 지켜야하는 것

• clear purpose
• predictable result
• maintainable

개요

Here are some guidelines to consider when crafting methods:

1. Single Responsibility Principle: Each method should have a single responsibility. It should perform only one task. This makes it easier to maintain and test.
2. Descriptive Naming: The method's name should clearly express what the method does. This makes the code more readable and understandable. For example: calculateSum() is better than calc().
3. Short and Sweet: If possible, keep your methods small. Methods that are shorter are easier to read and understand.
4. Avoid Side Effects: Your method should not affect anything beyond the scope of its operations, keeping a predictable behavior.
5. Use Parameters Wisely: Consider the number of parameters your method requires. Too many parameters can make a method difficult to understand and use. Consider using an object to wrap these parameters if necessary.
6. Return Results When Possible: If possible, prefer methods that return results. This can make it easier to test the method and can sometimes result in cleaner code.
7. Commenting and Documentation: Use comments to explain complex code or algorithms. They will help others understand why and how a particular piece of code works. Adding a brief description of the purpose, parameters, and returned results in a method's documentation can be very helpful.

좋은 메서드 가이드라인에서, 사이드 이펙트를 피하라고 하였는데

• 인스턴스 메서드가 인스턴스 변수를 변경하는 것을 사이드이펙트라고 볼수 있을까?

  OOP 에서는 인스턴스 메서드가 인스턴스 변수를 변경하는 것을 사이드이펙트로 보지 않는다고 한다.

  단, 클래스가 잘 캡슐화 되어있다는 것을 전제한다

  예를 들어 Array 클래스에서 append() 메서드는 인스턴스 변수를 수정하면서 메서드의 이름에 걸맞는 작업을 수행해낸다. 이것을 primary effect 라고 표현하기도 하는 것 같다.

• 위 가이드라인에서 가리키는 사이드이펙트는 코드 사용자에게 unpredictable 한 결과를 주는 코드를 말하는 것 같다.

  the method is designed with the explicit purpose to change the variable and that's its expected primary effect.