Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Comment a source code #41

Closed
Tracked by #26
matjazv opened this issue Aug 26, 2022 · 0 comments · Fixed by #76
Closed
Tracked by #26

Comment a source code #41

matjazv opened this issue Aug 26, 2022 · 0 comments · Fixed by #76
Assignees
@shuse2
Labels
type: docs type: standards
Milestone
Sprint 11

Comments

@matjazv
Copy link
Contributor

matjazv commented Aug 26, 2022

Description

  • comments help that future code maintenance/extension is easier and faster, and reviewers and newcomers can understand the code better
  • there should be a good balance regarding number of lines between code and comments

Acceptance Criteria

  • any public fields, functions and methods should be documented

Additional Information
@shuse2 shuse2 mentioned this issue Aug 26, 2022
Closed
20 tasks
@shuse2 shuse2 added this to the Sprint 10 milestone Oct 10, 2022
@shuse2 shuse2 modified the milestones: Sprint 10, Sprint 11 Oct 24, 2022
@shuse2 shuse2 self-assigned this Oct 28, 2022
@shuse2 shuse2 mentioned this issue Oct 29, 2022
Merged
shuse2 added a commit that referenced this issue Oct 31, 2022
@shuse2
Add documentation and comments - Closes #41 (#76)
94522fb 
### What was the problem?

This PR resolves #41 

### How was it solved?

- Add documentation script to package.json
- Add documentation comments
- Add additional comments for the code
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@shuse2 shuse2

Labels
type: docs type: standards
Projects
None yet
Milestone
Sprint 11
Development

Successfully merging a pull request may close this issue.

Add documentation and comments - Closes #41 LiskArchive/lisk-db
2 participants
@matjazv @shuse2