MRI.COM

MRI.COM Doxygen

サブルーチン等を説明するコメントは Doxygen の記法に従う。 doxygen による解析実行はソースコード・パッケージ中の docs/README_Tree.md を参照。

サンプル

!> @brief 短波放射による水温時間変化量を計算する
!! @param[in] qswnt 海面の短波入射[]
!! @param[out] t_tend_sw_absorb 短波放射の吸収による水温時間変化量 [K/s]
!! @param[out] qsw_flux グリッド底を通過する短波入射の熱フラックス []
subroutine

!> @brief Compute friction velocity on T-points on the basis of air-sea stress
!!   using surface wind stress on UV-points
!! @param[in]  strsx_ao   X-ward wind stress [dyn/cm^2]
!! @param[in]  strsy_ao   Y-ward wind stress [dyn/cm^2]
!! @param[out] obj%frcvl  Friction velocity [m/s]

real(8),save :: strsy_ao (imx,jmx) !< wind stress ocean receives from atmosphere (Y-ward) [dyn/cm^2]

引数リストは縦に揃えると見やすい。