docs: 统一公开 API 的中英双语注释
- 补齐公开接口说明段的英文描述,保持签名注释和详细说明均为中英双语结构 - 规范农历、坐标、公式、轨道、日晷、太阳、恒星及行星事件等 API 的注释口径
This commit is contained in:
@@ -12,6 +12,8 @@ const darkAdaptedPupilDiameterMM = 7.0
|
||||
// 返回:
|
||||
//
|
||||
// 集光力比值,等于 (diameter1MM / diameter2MM)^2
|
||||
//
|
||||
// Returns the light-gathering power ratio, equal to (diameter1MM / diameter2MM)^2.
|
||||
func LightGatheringPowerRatio(diameter1MM, diameter2MM float64) float64 {
|
||||
if diameter1MM <= 0 || diameter2MM <= 0 ||
|
||||
math.IsNaN(diameter1MM) || math.IsInf(diameter1MM, 0) ||
|
||||
@@ -28,6 +30,8 @@ func LightGatheringPowerRatio(diameter1MM, diameter2MM float64) float64 {
|
||||
// 返回:
|
||||
//
|
||||
// Dawes 极限,单位角秒
|
||||
//
|
||||
// Returns the Dawes limit in arcseconds for the supplied aperture.
|
||||
func DawesLimitArcsec(diameterMM float64) float64 {
|
||||
if diameterMM <= 0 || math.IsNaN(diameterMM) || math.IsInf(diameterMM, 0) {
|
||||
return math.NaN()
|
||||
@@ -42,6 +46,8 @@ func DawesLimitArcsec(diameterMM float64) float64 {
|
||||
// 返回:
|
||||
//
|
||||
// Rayleigh 极限,单位角秒
|
||||
//
|
||||
// Returns the Rayleigh limit in arcseconds for the supplied aperture.
|
||||
func RayleighLimitArcsec(diameterMM float64) float64 {
|
||||
if diameterMM <= 0 || math.IsNaN(diameterMM) || math.IsInf(diameterMM, 0) {
|
||||
return math.NaN()
|
||||
@@ -58,6 +64,8 @@ func RayleighLimitArcsec(diameterMM float64) float64 {
|
||||
//
|
||||
// 经验极限星等;这是经验值,不包含天空背景、倍率、透过率和观测经验修正
|
||||
//
|
||||
// Returns an empirical limiting magnitude estimate. It does not account for sky background, magnification, transmission, or observer skill.
|
||||
//
|
||||
// 例:
|
||||
//
|
||||
// // 70mm 小型折射镜,裸眼极限 6 等
|
||||
|
||||
Reference in New Issue
Block a user