Cách viết báo cáo code app android sau khi hoàn thiện bằng comment

thanhDat · May 29, 2018, 2:11pm

đây là code android của em. em đang làm bài báo cáo về code này. bình thường thì copy thẳng code bằng tay vào word rồi comment từng đoạn nhỏ

và cho em hỏi là làm thế nào để nó ra được code thành từng đoạn khoa học như thế này.

em có tìm hiểu và có thể làm được không biết có phải apidoc không ạ? và ai biết thì cho em xin keyword

huynhtinh · May 29, 2018, 2:19pm

Nếu comment nhiều dòng thì dùng documentation comment: /**… */

Ví dụ
/** Đây là document của mình */

Tham khảo thêm: https://www.tutorialspoint.com/java/java_documentation.htm

Còn câu hỏi còn lại bạn search Markdown nhé. HIện tại có rất nhiều bộ Markdown tùy vào platform của website sử dụng.

hell6w9rld · May 29, 2018, 3:33pm

Đỗ Thành Đạt K9 hay K10 NAEM phải không nhỉ
Theo ý kiến của mình
Câu 1: Trong code không nên lạm dùng comment giải thích quá nhiều. Có nhiều bạn giải thích vào code chi tiết đến từng biến, từng hàm , từng scope. Để khi báo cáo trình bày cho tiện hoặc sợ sau này quên nhưng không nên. Thứ 1 là làm code thêm chữ nhìn rối mắt, thứ 2 là code đặt tên biến, tên hàm nếu biết cách đặt thì đã 1 phần phản ánh nội dung, ý nghĩa của nó rồi nên không cần đặt thêm comment làm gì. Trong java có java doc dùng để mô tả ý nghĩa hàm, các tham số in out cho 1 hàm hoặc 1 class thì có thể dùng nhưng hạn chế comment như trên nha. Nếu là mình code thì nhìn vào code là có thể nói rồi, không phải cmt chi tiết vậy

Cấu 2: Bạn muốn chèn code vào file word cho đẹp thì nên làm theo các gợi ý sau

code phải có border (trong word có, có thể dùng table đó)
nền code không nên có màu, nếu có thì màu nhạt, vì khi in sẽ gây đen sì phần nền sẽ không thấy chữ
code có thể để hightlight
mình hay làm như sau, khi in ra dễ nhìn. Còn làm màu mè như trên, khi đọc trên máy tính có vẻ đẹp. Nhưng in ra nhìn chán đời lắm

Hoặc bạn có thể dùng mấy trang markdown trên mạng, paste code lên, copy cái đã highlight rồi paste về word. Chọn cái nào màu nhạt đấy

http://markup.su/highlighter/
http://www.planetb.ca/syntax-highlight-word

Còn nữa: Nhìn hình thì thấy bạn làm đề tài về NPL. Xử lý ngôn ngữ tự nhiên speed to text. Không biết bạn dùng fw hay lib, tool, api nào. Hay tự build a-z. Dùng phương pháp nào, có dùng ml hay dl không?

thanhDat · May 29, 2018, 4:23pm

Vâng. em xin cảm ơn anh. thật tuyệt vời.

thanhDat · May 29, 2018, 4:33pm

Anh Long ở A.N lab đúng không. vâng em thấy cái apidocjs nên cũng thử làm theo. nó sẽ như thế này http://api.kohivietnam.com/api-doc/
Cài nodejs xong chạy mà nó cứ lỗi. thêm configuration rồi nó cũng chẳng được. nên em mới hỏi xem ai có cách nào không

markdown cũng được đấy anh ạ.
em chỉ làm bằng api mục đích học ngôn ngữ thôi anh

hi