Project

General

Profile

Feature #1269

Commenter - Week12 - First Task

Added by Kentaro HARATAKE 5 months ago. Updated 4 months ago.

Status:
Resolved
Priority:
High
Assignee:
Start date:
12/12/2024
Due date:
12/20/2024 (about 4 months late)
% Done:

100%

Estimated time:
3.00 h
Spent time:

Description

Please check how to comment in Doxygen style in python.
you can review Task9 in Week09 assignment which you already finished and submitted.

If you don't know it, plz look it up. Write some comments on some sample codes (such as Week09 codes provided by prof), generate a documentation using Doxygen (you can check class materials), and check if the comments are reflected.

I put some links here for commenting (use them as just references)
https://stackoverflow.com/questions/4302870/doxygen-syntax-in-python
https://www.woolseyworkshop.com/2020/06/25/documenting-python-programs-with-doxygen/

plz put your spent time every time after you work.

Once you understood everything that you can comment and generate expected comments with Doxygen, plz make this issue "resolved" from edit.

#1

Updated by Kentaro HARATAKE 5 months ago

  • Subject changed from 0 - Commenters to 0 - Commenters Main Task
#2

Updated by Toma IKUTA 5 months ago

  • Subject changed from 0 - Commenters Main Task to Week12 - Commenting First Task
  • Due date set to 12/18/2024
  • Assignee set to Jiaye DING
  • Priority changed from Urgent to High
  • Estimated time set to 3.00 h
#3

Updated by Toma IKUTA 5 months ago

  • Description updated (diff)
#4

Updated by Toma IKUTA 5 months ago

  • Description updated (diff)
#5

Updated by Toma IKUTA 5 months ago

  • Description updated (diff)
#6

Updated by Toma IKUTA 5 months ago

  • Subject changed from Week12 - Commenting First Task to Commenter - Week12 - First Task
#7

Updated by Toma IKUTA 5 months ago

  • Status changed from New to In Progress
#8

Updated by Toma IKUTA 5 months ago

  • Due date changed from 12/18/2024 to 12/19/2024
#9

Updated by Jiaye DING 4 months ago

  • Status changed from In Progress to Resolved
  • % Done changed from 0 to 100

Complete the doxgen comment for Python

#10

Updated by Jiaye DING 4 months ago

  • Due date changed from 12/19/2024 to 12/20/2024

https://blog.csdn.net/crylearner/article/details/38798455
###doxygen + doxypypy + docstring generate python documents

Also available in: Atom PDF