Framemaker文書のソースコードをフォーマットする方法は？ [閉まっている]

Question

Framemakerでさまざまなプログラミングソースコードを説明する技術文書を作成する必要があります。

したがって、私のドキュメントは、一連のテキストで構成され、その後に一連のソースコード（Java、XML）が続き、その後にさらにテキストなどが続きます。

この質問は、Framemakerを使用する必要があるかどうかに関するものではありません。つまり、使用する必要があるソフトウェアです。 。 。

私が混乱しているのは、ドキュメントの一部としてソースコードをフォーマットする方法です。誰かが技術文書のためにこれを行って、指示やヒントを見つけましたか？これまでのところ、私のグーグルは私がする必要があることに関連するものを作成していません。

Answer 1

少なくとも、サンプルコードの段落スタイルを作成し、適切な等幅フォントを使用し、ハイフネーションをオフにすることを忘れないでください。

これを使用していたときに、テーブルスタイルを作成し、そこにコードを貼り付けるため、上に素敵なタイトルヘッダーがあり、少し目立ちました。唯一の落とし穴は、フレームテーブルのセルが改ページをまたがらないことです。そのため、コードがページよりも長いか、ページの最下部より下になると脅した場合は、テーブルに複数の行を作成し、コードを行に分割します。

Answer 2

数年前にこれについて書いた論文から、来週再びオンラインで利用できるようになります。

タイポグラファーは主に読みやすさに関心があり、ツール、慣行、伝統を持っています テキストを設定する際に依存する何百年、実際には何千年も遡ります 自然言語。ただし、コンピュータープログラムは自然言語で書かれていません。彼ら ＆＃8216;プログラミング言語＆＃8217;で書かれています：独自のルールを持つ人工言語 構文、プレゼンテーションの独自の規則、および可読性の独自の基準。コンピューター したがって、コードは、音楽、数学、化学と同様に、組版の特別な領域です。 これらのドメインには独自のルールがありますが、これはナチュラルを設定するときに使用されるルールではありません 言語。

コンピュータープログラミング自体はごく最近のものであり、 型に設定する慣行は約45年以上遡りません。 コンピュータコードは過去20年以内に公開されました。関連する誤植 規律は未熟であるか、実際に実際には存在しません。 多くの業界書を調べるとわかるように、現場の開業医の期待も低くなっています。うまくやれない理由はありません。

1. サンセリフフォントを使用します。私の本の1つで、同じフォントファミリ、テキストにFF Scala、コードにFF Scala Sansを使用しました。見た目は素晴らしいと思いますが、相反する意見があります。個人的にはこれは非常に時代遅れだと思いますが、これらは固定幅フォントを使用せざるを得ないかもしれません。クーリエは避けてください。何にも混じりません。

2. インデントは表記法の一部です。既存の左インデントを尊重する必要があります。ソースコードはすでにタブ化されています。各タブを最大で1つまたは2つのスペースに減らします。そうしないと、水平方向の部屋が不足します。

3. 可能な限り多くの垂直方向のスペースを失うようにしてください。空白行を非表示にします。サンプル全体を1ページにまとめてみてください。必要に応じてフロートさせてください。

4. 改行は表記の一部です。著者に相談せずに改行を追加しないでください。

5. 引用符は表記の一部です。シングルをダブルに、またはその逆に変更しないでください。

6. ジャスティフィケーション：コンピュータープログラムは常に左寄せ、右寄せで記述、表示、設定されます。

7. 改ページ。本にコンピューターコードを設定する場合、改ページは、自然言語を植字するときに使用される単純な孤児/未亡人の原則に従うだけではありません。代わりに、論理的な＆＃8216;ブロック＆＃8217;可能であれば、コードをまとめておく必要があります。通常、タイポグラファーにとっては不可能です コード内のブロック境界を決定しますが、一般的には空白行が許容されます 改ページのポイント。 ＆＃8216;ブロックコメント＆＃8217;次のコードブロックで保持する必要があります。 これらが何であるかわからない場合は、著者に問い合わせてください。

8. ハイフネーション。プログラミング言語は自然言語ではないため、通常のハイフネーション規則に従っていません。ハイフネーションを行う必要がある場合は著者に相談してください。作成者の指示に従う場合を除き、プログラムテキスト内の単語をハイフンでつないだり、改行したりしないでください。

9. 大文字と小文字。プログラムコードのケースは通常、コンピューターにとって重要であり、実際には常に作家とその読者にとって重要です。大文字と小文字が異なるだけで、異なるものを表す単語のペアがよく使用されます。 BufferedOutputStreamおよびbufferedOutputStream。 プログラマ、特に作者プログラマは、通常、非常に体系的です。 場合、タイポグラファー（または他のプログラマー）にとって必ずしも意味をなさないかもしれない方法で。

実用的な推奨事項

• em単位でインデントします。組版コンピュータプログラムの多くの問題の解決策はemです。著者の