JavaScript percentage calculation functions
$begingroup$
I am building a calculator and I'm aware of what these functions do.
What I basically want feedback on is: Do I need to comment this or is there sufficient information to ascertain its purpose:
function percentOfValue(percentage, of) {
return (percentage / 100) * of;
}
function whatPercentOfValue(small, large) {
return (small / large) * 100
}
javascript
New contributor
$endgroup$
add a comment |
$begingroup$
I am building a calculator and I'm aware of what these functions do.
What I basically want feedback on is: Do I need to comment this or is there sufficient information to ascertain its purpose:
function percentOfValue(percentage, of) {
return (percentage / 100) * of;
}
function whatPercentOfValue(small, large) {
return (small / large) * 100
}
javascript
New contributor
$endgroup$
add a comment |
$begingroup$
I am building a calculator and I'm aware of what these functions do.
What I basically want feedback on is: Do I need to comment this or is there sufficient information to ascertain its purpose:
function percentOfValue(percentage, of) {
return (percentage / 100) * of;
}
function whatPercentOfValue(small, large) {
return (small / large) * 100
}
javascript
New contributor
$endgroup$
I am building a calculator and I'm aware of what these functions do.
What I basically want feedback on is: Do I need to comment this or is there sufficient information to ascertain its purpose:
function percentOfValue(percentage, of) {
return (percentage / 100) * of;
}
function whatPercentOfValue(small, large) {
return (small / large) * 100
}
javascript
javascript
New contributor
New contributor
edited 8 mins ago
200_success
130k17155419
130k17155419
New contributor
asked 4 hours ago
ChrisChris
1042
1042
New contributor
New contributor
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
$begingroup$
Code level comments usually lose their context if not properly maintained. Using self descriptive variable names is a good choice. Appreciate your efforts in keeping the code highly readable.
First method, is trying to get the Percentage value, I would update the method definition to
getPercentOfValue(from, percentage)
.Second method, is trying to calculate percent rate, I would update the method definition to
getPercentRate(newValue, originalValue)
to follow the terminology in formula.
New contributor
$endgroup$
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
return StackExchange.using("mathjaxEditing", function () {
StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
});
});
}, "mathjax-editing");
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "196"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Chris is a new contributor. Be nice, and check out our Code of Conduct.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f216126%2fjavascript-percentage-calculation-functions%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
$begingroup$
Code level comments usually lose their context if not properly maintained. Using self descriptive variable names is a good choice. Appreciate your efforts in keeping the code highly readable.
First method, is trying to get the Percentage value, I would update the method definition to
getPercentOfValue(from, percentage)
.Second method, is trying to calculate percent rate, I would update the method definition to
getPercentRate(newValue, originalValue)
to follow the terminology in formula.
New contributor
$endgroup$
add a comment |
$begingroup$
Code level comments usually lose their context if not properly maintained. Using self descriptive variable names is a good choice. Appreciate your efforts in keeping the code highly readable.
First method, is trying to get the Percentage value, I would update the method definition to
getPercentOfValue(from, percentage)
.Second method, is trying to calculate percent rate, I would update the method definition to
getPercentRate(newValue, originalValue)
to follow the terminology in formula.
New contributor
$endgroup$
add a comment |
$begingroup$
Code level comments usually lose their context if not properly maintained. Using self descriptive variable names is a good choice. Appreciate your efforts in keeping the code highly readable.
First method, is trying to get the Percentage value, I would update the method definition to
getPercentOfValue(from, percentage)
.Second method, is trying to calculate percent rate, I would update the method definition to
getPercentRate(newValue, originalValue)
to follow the terminology in formula.
New contributor
$endgroup$
Code level comments usually lose their context if not properly maintained. Using self descriptive variable names is a good choice. Appreciate your efforts in keeping the code highly readable.
First method, is trying to get the Percentage value, I would update the method definition to
getPercentOfValue(from, percentage)
.Second method, is trying to calculate percent rate, I would update the method definition to
getPercentRate(newValue, originalValue)
to follow the terminology in formula.
New contributor
New contributor
answered 56 mins ago
brightDotbrightDot
92
92
New contributor
New contributor
add a comment |
add a comment |
Chris is a new contributor. Be nice, and check out our Code of Conduct.
Chris is a new contributor. Be nice, and check out our Code of Conduct.
Chris is a new contributor. Be nice, and check out our Code of Conduct.
Chris is a new contributor. Be nice, and check out our Code of Conduct.
Thanks for contributing an answer to Code Review Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
Use MathJax to format equations. MathJax reference.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f216126%2fjavascript-percentage-calculation-functions%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown