Documentation template for class Trajectory#64
Open
Daniel-Tojal wants to merge 26 commits intoadhusch:developfrom
Open
Documentation template for class Trajectory#64Daniel-Tojal wants to merge 26 commits intoadhusch:developfrom
Daniel-Tojal wants to merge 26 commits intoadhusch:developfrom
Conversation
Daniel-Tojal
commented
May 25, 2019
| % University of Luxembourg - Luxembourg Centre for Systems Biomedicne | ||
| % 2013 - 2017 | ||
| % mail@andreashusch.de | ||
| classdef Trajectory < handle & matlab.mixin.Copyable & MetaTrajectory |
Contributor
Author
There was a problem hiding this comment.
@adhusch , could you please have a look through the file and check if everything has been properly documented with the right descriptions?
adhusch
requested changes
Jun 21, 2019
Owner
There was a problem hiding this comment.
I would prefer to not comment self-explanatory standard getters and setters at all. E.g.:
function value = getTargetPoint(this)
% Function that gets the coordinates of the target point
%
% Parameters:
%
% this: Self-Reference
%
% Returns:
%
% value: Target point coordinates.
value = this.targetPoint3D.point;
end
The comment adds zero information but blows up the code and decreases readability.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.