Thuật toán và mã nguồn trong bài
Phác thảo thuật toán với algorithm2e và chèn mã thật với listings.
Thuật toán và mã nguồn trong bài
Bài báo trình bày mã theo hai dạng khác nhau, và LaTeX có một công cụ riêng cho mỗi dạng. Mã giả là bản phác thảo lý tưởng hóa của một thuật toán, được dàn trang bằng từ khóa và công thức toán, và gói algorithm2e lo phần này. Mã nguồn là mã thật được chép nguyên văn bằng phông đơn cách, và gói listings lo phần đó. Chọn nhầm công cụ là nguồn gốc quen thuộc của rắc rối, nên xem cả hai sẽ có ích.
Mã giả với algorithm2e
\usepackage[ruled,vlined]{algorithm2e}\begin{algorithm}\caption{Train}\While{not converged}{ Update $\theta$\;}\end{algorithm}Các tùy chọn của gói quyết định kiểu trình bày: ruled kẻ đường ngang phía trên và phía dưới thuật toán và đặt chú thích ở trên cùng, quy ước mà hầu hết các hội nghị đều mong đợi, còn vlined kẻ một đường dọc nhỏ để đánh dấu phạm vi của từng khối, nhờ vậy các khối lồng nhau vẫn dễ đọc mà không cần thụt lề nhiều. Môi trường algorithm là một float, giống hình, nên nó mang \caption để có số thứ tự cho \ref trích dẫn.
Bên trong, \While{condition}{body} dàn trang vòng lặp với từ khóa in đậm, điều kiện, và phần thân là một khối thụt lề. \For, \If và \Return cũng theo mẫu đó. Các câu lệnh kết thúc bằng \;, lệnh này in dấu kết thúc dòng và xuống dòng mới. Quên nó là lỗi kinh điển của người mới: các dòng dính liền vào nhau. Vì đây là LaTeX bình thường, công thức như $\theta$ dùng được ngay trong dòng, và đó chính là mục đích của mã giả: mô tả quy tắc cập nhật bằng ký hiệu thay vì bằng một ngôn ngữ lập trình cụ thể nào.
Mã thật với listings
\usepackage{listings}\begin{lstlisting}[language=Python]def f(x): return x**2\end{lstlisting}Môi trường lstlisting tái hiện nội dung chính xác từng ký tự, giữ nguyên khoảng trắng và xử lý ký tự đặc biệt theo nghĩa đen, nên bạn có thể dán mã vào mà không cần escape gì cả. Tùy chọn language=Python bật tô sáng từ khóa cho ngôn ngữ đó, và listings biết hàng chục ngôn ngữ khác. Mặc định, kết quả khá đơn giản. Hầu hết mọi người thêm một lần \lstset{basicstyle=\ttfamily\small, numbers=left} vào preamble để có phông đơn cách cỡ vừa phải kèm số dòng. Nếu muốn nhúng trực tiếp một tệp thay vì dán, \lstinputlisting[language=Python]{train.py} sẽ đọc tệp từ đĩa, giúp bài báo luôn khớp với mã nguồn thực. Nếu bạn muốn tô màu với độ chính xác cao, gói minted là lựa chọn mạnh hơn, nhưng đổi lại cần một công cụ bên ngoài và shell escape.
Chọn giữa hai cách
Hãy dùng mã giả trong phần thân bài để truyền đạt ý tưởng, và để dành mã nguyên văn cho những chỗ cần đúng từng dòng, như phụ lục hoặc phần mô tả công cụ. Một lỗi hay gặp là đặt lstlisting trong một frame Beamer mà không có tùy chọn [fragile], và gặp một thông báo lỗi khó hiểu; lưu ý tương tự cũng xuất hiện trong bộ slide Beamer đầu tiên.