我正在和大学里的一些朋友为我们正在进行的一个项目编写代码用户指南,并希望将以下类型的东西打包到环境中。目前我们的方法有些不成熟:
{\textcolor{purple}{{\textbf{\url{ClassName}}}}}
\textcolor{brown}{\hspace{2em} \url{type}} \url{ firstMethodName}: An easy to describe function
\textcolor{brown}{\hspace{2em} \url{type}} \url{ secondMethodName}: Some long description which wraps around onto the next line because it is too long for one line
输出结果如下:
存在以下几个问题:
- 描述的开头(这里“一个简单的……”和“一些长的……”最好处于相同的缩进级别 - 目前这有点不协调)
- 显示的长描述会与周围的文字一起换行到下一行,看起来很糟糕。有没有办法说类似此处的任何散文都应从此缩进级别开始,直至另行通知这样,“因为一行太长而无法写成一行”会与“一些长描述”对齐吗?
谢谢阅读!任何帮助都将不胜感激。
答案1
这是一个tabularx
基于 的解决方案。前两列分别为r
和类型l
,第三列为 类型X
,这意味着它占用尽可能多的空间,同时允许自动换行。
\documentclass{article}
\usepackage{xcolor,tabularx,ragged2e,url}
\newcolumntype{L}{>{\RaggedRight\arraybackslash}X}
\begin{document}
\noindent\textcolor{red}{Before:}\strut\hrule\smallskip\noindent
{\textcolor{purple}{{\textbf{\url{ClassName}}}}}
\textcolor{brown}{\hspace{2em} \url{type}} \url{ firstMethodName}: An easy to describe function
\textcolor{brown}{\hspace{2em} \url{type}} \url{ secondMethodName}: Some long description which wraps around onto the next line because it is too long for one line
\bigskip
\noindent\textcolor{red}{After:}\strut\hrule\smallskip\noindent
\begin{tabularx}{\textwidth}{@{} >{\ttfamily}r >{\ttfamily}l L @{}}
\color{purple}\textbf{ClassName} \\
\color{brown}type & firstMethodName & An easy to describe function\\[0.5ex]
\color{brown}type & secondMethodName & Some long description which wraps around onto the next line because it is too long for one line \\
\end{tabularx}
\end{document}