'수학적'기능이 수학적 표기법을 따라야합니까?

나는이 질문이 즉시 주관적으로 표시 될 것이라고 생각하지만, 어느 것이 더 낫다고 생각합니까?

double volume(double pressure, double n_moles, double temperature) {
  return n_moles * BOLTZMANN_CONSTANT * temperature / pressure;
}

또는

double volume(double P, double n, double T) {
  return n*R*T/P;
}

다시 말해, 일부 방정식을 구현하는 함수가 해당 방정식의 표기법을 따라야합니까, 아니면 더 자세한 이름을 사용해야합니까?

누가 읽고 있는지에 따라 다릅니다. 영원 토록 코드를 읽는 다음 프로그래머도 열역학에 익숙하다는 것을 보증 할 수 있다면, 잘린 버전으로 가십시오.

내 개인 스타일은 그러한 변수 (약어는이 분야에서 일반적으로 알려져 있음)를 사용하지만 주석에 설명을 포함시키는 것입니다.

/* P : Pressure
   V : Volume
   n : Number of moles
   R : Boltzmann constant
   T : Temperature (in K)
*/
double compute_V(double P, double n, double T) {
  return n*R*T/P;
}

그냥 버리고 또 다른 옵션이 있습니다.

Volume ComputeVolume(Pressure p, Moles m, Temperature t) { ... }

이는 F #과 측정 단위의 기능과 다소 유사하며 실수로 압력을 온도로 대체하는 등의 문제를 피할 수 있다는 이점이 있습니다. 서명이 어디에있을 때 어떤 인수를 가야하는지 시인하기가 어렵습니다 (더블, 더블, 더블)

나는 이것을 선호한다 :

/* This function calculates volume using the following formula:
 *
 *     n * R * T
 * v = ---------
 *         P
 */
double volume(double pressure, double n_moles, double temperature) {
    return n_moles * BOLTZMANN_CONSTANT * temperature / pressure;
}

다시 말해, 주석에서 코드의 의미를 영어로 설명하고 (수학 : 주석이므로 필요한만큼 확장 할 수 있음) 설명 변수 이름을 사용하여 유일한 코드를 읽는 사람은 여전히 ​​이해할 수 있습니다. 더 큰 기능을 사용하면 쉽게 할 수 있습니다. 실제 단어를 변수 이름으로 사용하는 또 다른 이유는 함수 선언을 헤더 파일에 복사 해야하는 경우 인터페이스가 훨씬 명확하기 때문입니다.

IMHO 기능이 매우 도메인별로 고유 한 경우 작업중인 문제 도메인의 기존 표기법을 사용하는 것이 좋습니다. 문제 도메인을 이해하지 못하는 사람은 코드를 성공적으로 유지할 가능성이 없으며 도메인에 익숙한 사람에게는 긴 이름이 소음이 많고 입력이 더 많아 질 것입니다.

OTHO, 나는 전통적인 수학적 표기법이 때때로 더 장황하고 서술 적이기를 원하지만, 수학적 코드가 수학적 규칙을 고수해야한다고 생각합니다.

편집 :이 답변은 수식을 수학적으로 작성할 때 표기법에 대한 매우 강력한 규칙이있는 경우에만 적용됩니다. 하나가 없으며 독자가 도메인에 익숙하다고 가정하더라도 변수가 주석에서 나타내는 내용을 설명 해야하는 경우 더 설명적인 규칙의 측면에서 오류를 범하는 것이 가장 좋습니다.

순수한 의견이지만 항상 단일 문자 기호 위에있는 단어를 사용하십시오. 단어를 사용하면 모든 사람들이 이해할 것입니다. 기호를 사용하는 경우 주제 전문가 만 따라야합니다. 그럼에도 불구하고 일부 사람들은 동일한 물리량에 대해 다른 기호를 사용합니다. 더 긴 이름을 사용하면 잃을 것이 없습니다.

귀하의 우려는 명확하고 정확한 것이어야합니다 (올바르지 않지만 명확한 코드는 쉽게 수정됩니다). 따라서 가능한 한 일반 코더가 유지 보수 할 수 있도록 함수를 작성해야합니다. 함수 헤더 주석은 공식과 사용법을 설명하고 입력 / 출력 매개 변수를 설명해야합니다. 그런 다음 함수 본문이 레이아웃되는 방식은 헤더 주석과 일치하는 한 크게 중요하지 않아야합니다.

(이것은 토론이 아니라는 것을 알고 있지만-개인적인 선호는 변수에 명시적인 이름을 부여하는 것이지만,이 경우 하나의 라이너는 '순수한'기능이므로 충분할 수 있습니다. 동일한 매개 변수를 사용하면 동일한 결과를 얻을 수 있습니다 항상 결과이므로 설명이 필요한 상태 관련 복잡성이 없어야 함)

• 차원 분석을 지원하는 다른 언어와 마찬가지로 C ++에서 템플릿을 사용하여 구현할 수 있으며 Boost Units 라이브러리는 내가 생각하는이 접근법을 사용합니다.

코드가 비즈니스 계층에서 얼마나 "멀리 떨어져"있는지에 따라 ... 코드가 쌓여있는 furthur는 코드가 추상적 인 수학 함수를 구현할수록 더 많이 타겟팅 될수록 일반적으로 수용되는 것을 더 모방하려고합니다. matehmatical 표기법 및 명명 규칙. 프런트 엔드 또는 비즈니스 계층에 가까울수록 문제 영역에서 설정된 규칙을 더 많이 준수합니다.

나는 이것을 이런 식으로 생각하고 싶다- 수학자들은 짧은 변수로 틀렸고 물리학 자들은 그에 따라 행동했다 . 왜 실수를 반복합니까? 이름이 길수록 설명하기 쉽고 혼동이 줄어든다는 사실을 알았습니다. 더 가벼운 말로, 때로는 더 긴 변수를 수학에 몰래 넣으려고합니다.

프로그래밍 방정식의 올바른 형식은 6 개월 동안 보지 못한 후에도 여전히 이해하는 형식입니다.

다시 오면 :

n*R*T/P;

그리고 당신은 무슨 일이 일어나고 있는지 알면 아마 괜찮을 것입니다. 일반적으로 고급 수식의 경우 적극적으로 사용하지 않으면 각 부분이 무엇인지 기억 하지 못합니다 . 나를 위해 :

n_moles * BOLTZMANN_CONSTANT * temperature / pressure;

수식이 왜 쓰여져 있는지 알 필요가 없더라도 각 부분을 쉽게 이해할 수 있기 때문에 특히 더 나은 수식 형식 입니다.

동전을 던져.

또한 코딩 자체에 쓰는 것보다 변수 이름을 지정하는 방법에 대해 더 많은 시간을 할애합니까?