Có chương trình nào có thể giúp hiểu chương trình khác không?

Question

Tôi cần ghi lại phần mềm mà tôi hiện đang làm việc. Phần mềm này bao gồm một số ngôn ngữ lập trình và các kịch bản mà tôi đã suy nghĩ. Nếu một nhà phát triển mới đến và cần phải sửa chữa một cái gì đó, họ có thể biết Java nhưng có thể không bash scripting. Sẽ thật tuyệt nếu có một chương trình giúp bạn hiểu những gì

for f in "$@" ; do 

có nghĩa là. Tôi đã nghĩ đến cái gì đó tạo ra một trang HTML tĩnh với mã cộng với cú pháp nổi bật và nếu bạn di chuột qua một cái gì đó (như "cho"), nó sẽ hiển thị một cửa sổ pop-up với một lời giải thích:

for bắt đầu một vòng lặp lặp qua tất cả các giá trị theo sau in. Trong vòng lặp, bạn có thể truy cập từng giá trị thông qua biến số $f. Nội dung vòng lặp nằm giữa do và done

Có điều gì đó như vậy đã tồn tại chưa?

[EDIT] Đây chỉ là một ví dụ. Bạn sẽ nhận được trợ giúp khác cho f, in, "$@", ; và do, tức là mỗi phần tử của dòng cần được giải thích. Các phần tử không xác định (như tên lệnh) phải liên kết với Google. Vì vậy, bạn có thể hiểu những gì nó làm ngay cả khi bạn đang thiếu một số chi tiết.

[EDIT2] Tôi biết rằng bạn không thể viết chương trình hiểu được chương trình khác làm gì. Những gì tôi đang tìm kiếm là một công cụ đơn giản sẽ làm "làm nổi bật cú pháp mở rộng" theo nghĩa là nó sẽ tô màu một biểu thức và cung cấp cho một lời giải thích ngắn gọn (có thể là một liên kết đến một số tham chiếu chuyên sâu).

Điều này dành cho người biết cách lập trình nhưng có thể chưa từng thấy một số cấu trúc tối nghĩa trước đây. Nói

echo "Error" 1>&2 

Mỗi lập trình viên bash biết điều này có nghĩa nhưng một nhà phát triển Java có thể bối rối bởi các 1>&2 mặc dù thực tế rằng họ có thể đoán rằng echo == System.out.println. Một đơn giản "chuyển hướng stdout để stderr" sẽ xóa mọi thứ lên và cho rằng ngay lập tức "AHA!" cho phép họ ở trong dòng suy nghĩ hiện tại của họ.

Answer 1

Nếu bạn nghĩ về nó, sẽ không hữu ích khi có công cụ giải thích cú pháp. Nhà phát triển chỉ có thể google cho các từ khóa thay vì duyệt một trang web theo cách tương tự như http://www.codeweblog.com/source/.

Tôi tin rằng các nhận xét tốt sẽ hữu ích hơn nhiều, cộng thêm có các công cụ để trích xuất tài liệu bằng cách sử dụng các chú thích (ví dụ, HappyDoc thực hiện điều đó cho Python).

Answer 2

Đó là một điều rất khó khăn. Trước hết theo định nghĩa nó có thể được chứng minh rằng chương trình sẽ "hiểu" bất kỳ chương trình nào không tồn tại. Tuy nhiên, bạn vẫn có thể sử dụng tài liệu hiện có. Có thể sử dụng các công cụ như Doxygen có thể giúp bạn. Bạn sẽ cần ghi lại mã của mình thông qua các nhận xét và tài liệu sẽ được tạo từ chúng.

Answer 3

IMO sẽ đơn giản và hiệu quả hơn khi chỉ thu thập các liên kết đến các tham chiếu và hướng dẫn cụ thể về ngôn ngữ tốt trên trang Wiki.

Đối với tất cả các ngôn ngữ chính thống, các nguồn như vậy tồn tại và được duy trì thường xuyên.Nếu bạn cố gắng tạo tham chiếu của riêng mình, bạn cũng cần duy trì nó. Công bằng đủ, cú pháp bash sẽ không thay đổi thường xuyên, nhưng các ngôn ngữ khác phát triển nhanh hơn, vì vậy nó sẽ là một gánh nặng.

Answer 4

Một ngôn ngữ không thể được giải thích chỉ thông qua cú pháp của nó. Môi trường thời gian chạy đóng một vai trò lớn, cùng với triết lý cơ bản của ngôn ngữ và các libraies.

Hơn nữa, cú pháp không phức tạp đối với hầu hết các ngôn ngữ phổ biến (do mã đó đã được viết với tính bảo trì).

Tiếp tục với ví dụ bash, bạn không thể hiểu bash nếu bạn không biết gì về quy trình & điều khiển công việc, biến môi trường, danh sách lớn lệnh unix (tr, sắp xếp, cắt, dán, sed, awk, find,. ..) và nhiều tính năng khác không xuất hiện trong cú pháp.

Answer 5

Một công cụ như thế này có thể được tạo bằng cách sử dụng ANTLR, tức là phân tích mã thành cây cú pháp trừu tượng bằng ngữ pháp ANTLR cho ngôn ngữ đó và viết trình tạo HTML tạo mã được chú thích.

Nghe có vẻ như một công cụ hữu ích để học ngôn ngữ hoặc khám phá mã nguồn của các dự án mà bạn không duy trì - nhưng nó có phù hợp với tài liệu không?

Tại sao điều quan trọng là giúp các lập trình viên của các ngôn ngữ khác hiểu mã ở cấp chi tiết triển khai này? Bất cứ ai duy trì việc thực hiện ở cấp độ này rõ ràng sẽ phải biết ngôn ngữ và có lẽ sẽ có một IDE để làm hầu hết điều này.

Điều đó nói rằng, tôi chắc chắn sẽ xem xét một công cụ như thế này như một trợ giúp học tập.

Answer 6

Nếu công cụ sản xuất

cho bắt đầu một vòng lặp mà lặp trên tất cả các giá trị mà làm theo. Trong các vòng lặp, bạn có thể truy cập vào mỗi giá trị qua biến $ f. Nội dung vòng lặp là giữa thực hiện và thực hiện

nó sẽ là vô giá trị. Đây chính xác là loại bình luận mà các lập trình viên (người) được đào tạo nói với nver để viết.